Convert **Note:** et al to GitHub Markdown alerts

Signed-off-by: Joachim Wiberg <[email protected]>

Author: troglobit

.github/CONTRIBUTING.md

@@ -24,7 +24,8 @@ the maintainer(s) and make it easier for them to include your code.
 Coding Style
 ------------
 
-> **Tip:** Always submit code that follows the style of surrounding code!
+> [!TIP]
+> Always submit code that follows the style of surrounding code!
 
 First of all, lines are allowed to be longer than 72 characters these
 days.  In fact, there exist no enforced maximum, but keeping it around

README.md

@@ -61,12 +61,13 @@ distributions:
   * [Alpine Linux](contrib/alpine/), and
   * [Debian GNU/Linux](contrib/debian/), also works on Ubuntu/Linux Mint
 
-> **Note:** support for various Linux distributions does not mean Finit
-> installs easily on all architectures.  The bundled install scripts are
-> examples for standard installations, tested on amd64 (x86_64) systems.
-> Custom setups, e.g., for embedded systems, can be found in any of the
-> following [Buildroot][] based examples: [myLinux][], [Infix][], or the
-> plain [br2-finit-demo](https://github.com/troglobit/br2-finit-demo).
+> [!NOTE]
+> Support for various Linux distributions does not mean Finit installs
+> easily on all architectures.  The bundled install scripts are examples
+> for standard installations, tested on amd64 (x86_64) systems.  Custom
+> setups, e.g., for embedded systems, can be found in the following
+> [Buildroot][] based examples: [myLinux][], [Infix][], or the plain
+> [br2-finit-demo](https://github.com/troglobit/br2-finit-demo).
 
 
 Example
@@ -78,9 +79,10 @@ be placed in `/etc/finit.d/available` and enabled by an operator using
 the [initctl](#commands--status) tool.  See the above mentioned Linux
 distributions, or [myLinux][].
 
-> **Note:** as of Finit v4.4, .conf lines can be broken up using the
-> standard UNIX continuation character (`\`), also trailing comments are
-> now supported.  The latter means you need to escape any hashes used in
+> [!TIP]
+> As of Finit v4.4, `.conf` lines can be broken up using the standard
+> UNIX continuation character (`\`), trailing comments are now also
+> supported.  The latter means you need to escape any hashes used in
 > directives and descriptions (`\#`).  For more on this and examples,
 > see the [finit.conf(5)][] manual or [doc/config.md](doc/config.md).
 
@@ -285,6 +287,7 @@ run  [S]                /path/to/ident    --
 task [2] <hw/model/foo> /path/to/foo-init -- Initializing Foo board
 ```
 
+> [!TIP]
 > Notice the trick with an empty description to hide the call to `ident`
 > in the Finit progress output.
 
@@ -367,9 +370,10 @@ The `initctl` tool has three commands to help debug and optimize the
 setup and monitoring of cgroups.  See the `ps`, `top`, and `cgroup`
 commands for details.
 
-> **Note:** systems that do not support cgroups, specifically version 2,
-> are automatically detected.  On such systems the above functionality
-> is disabled early at boot.
+> [!NOTE]
+> Systems that do not support cgroups, specifically version 2, are
+> automatically detected.  On such systems the above functionality is
+> disabled early at boot.
 
 
 Runparts & /etc/rc.local
@@ -573,9 +577,10 @@ file must be used to tell Finit to stop and start it on `reload` and
 `runlevel` changes.  If `<>` holds more [conditions](doc/conditions.md),
 these will also affect how a service is maintained.
 
-> **Note:** even though it is possible to start services not belonging in
-> the current runlevel these services will not be respawned automatically
-> by Finit if they exit (crash).  Hence, if the runlevel is 2, the below
+> [!NOTE]
+> Even though it is possible to start services not belonging in the
+> current runlevel these services will not be respawned automatically by
+> Finit if they exit (crash).  Hence, if the runlevel is 2, the below
 > Dropbear SSH service will not be restarted if it is killed or exits.
 
 The `status` command is the default, it displays a quick overview of all

contrib/alpine/README.md

@@ -1,7 +1,8 @@
 HowTo: Finit on Alpine Linux 3.4...3.19
 =======================================
 
-> **Blog** https://troglobit.com/post/2021-02-12-alpine-linux-with-finit/
+> [!TIP]
+> https://troglobit.com/post/2021-02-12-alpine-linux-with-finit/
 
 HowTo use Finit to boot an [Alpine Linux][] system.  It is assumed that
 the user has already installed make, a compiler, C library header files,

contrib/debian/README.md

@@ -20,8 +20,9 @@ tools pre-systemd work as intended.
 
     root@debian:~# apt install initscripts console-setup
 
-> **Note:** as of Debian 11 (Bullseye), libuev and libite are part of
-> the main section of Debian.  So just install the -dev packages :)
+> [!TIP]
+> As of Debian 11 (Bullseye), libuev and libite are part of the main
+> section of Debian.  So just install the -dev packages :)
 
 The following script can then be used to configure, build, install and
 set up your system to run Finit:
@@ -47,7 +48,8 @@ comands to `initctl`, followed by `reload` to activate your changes.
 You can also use a standard [/etc/rc.local](rc.local) for one-shot tasks
 and initialization like keyboard language etc.
 
-> **NOTE:** X Window system, you may need to `sudo apt install elogind`
+> [!NOTE]
+> For the X Window system, you may need to `sudo apt install elogind`
 > (Bullseye and later), followed by `initctl reload` to activate it (it
 > is enabled by default), and logout/login again.  The elogind daemon
 > ensures a regular non-root user can start and interact with an X

doc/build.md

@@ -1,5 +1,5 @@
-Building
-========
+Building Finit
+==============
 
 * [Introduction](#introduction)
 * [Configure](#configure)
@@ -17,14 +17,15 @@ optional plugins to enable.  It depends on two external libraries:
 - [libuEv][], the event loop
 - [libite][] (-lite), much needed frog DNA
 
-**NOTE:** Most free/open source software that uses `configure` default
-  to install to `/usr/local`.  However, some Linux distributions do no
-  longer search that path for installed software, e.g. Fedora and Alpine
-  Linux.  To get finit's configure script to find its dependencies you
-  have to help the `pkg-config` tool a bit if you do not change the
-  default prefix path:
-
-    PKG_CONFIG_LIBDIR=/usr/local/lib/pkgconfig ./configure
+> [!IMPORTANT]
+> Most free/open source software packages that use `configure` default
+> to install to `/usr/local`.  However, some Linux distributions do no
+> longer search that path for installed software, e.g. Fedora and Alpine
+> Linux.  To get finit's configure script to find its dependencies you
+> have to help the `pkg-config` tool a bit if you do not change the
+> default prefix path:
+>
+>     PKG_CONFIG_LIBDIR=/usr/local/lib/pkgconfig ./configure
 
 The configure script checks for all dependencies, including the correct
 version of the above mentioned libraries.  Currently required versions:
@@ -71,12 +72,13 @@ Below are a few of the main switches to configure:
 
 For more configure flags, see <kbd>./configure --help</kbd>
 
-> **Note:** the configure script is not available in the GIT sources.  It is
->           however included in (officially supported) released tarballs.  The
->           idea is that you should not need GNU autotools to build, only the
->           above mentioned dependencies, a POSIX shell, a C compiler and make.
->           Any contributing to Finit can generate it from `configure.ac` using
->           the `autogen.sh` script.
+> [!NOTE]
+> The configure script is not available in the GIT sources.  It is
+> however included in (officially supported) released tarballs.  The
+> idea is that you should not need GNU autotools to build, only the
+> above mentioned dependencies, a POSIX shell, a C compiler and make.
+> Any contributing to Finit can generate it from `configure.ac` using
+> the `autogen.sh` script.
 
 
 Example
@@ -115,10 +117,11 @@ Linux config to:
 
     CONFIG_UEVENT_HELPER_PATH="/sbin/mdev"
 
-**Note:** If you run into problems starting Finit, take a look at
-  `finit.c`.  One of the most common problems is a custom Linux kernel
-  build that lack `CONFIG_DEVTMPFS`.  Another is too much cruft in the
-  system `/etc/fstab`.
+> [!TIP]
+> If you run into problems starting Finit, take a look at `finit.c`.
+> One of the most common problems is a custom Linux kernel build that
+> lack `CONFIG_DEVTMPFS`.  Another is too much cruft in the system
+> `/etc/fstab`.
 
 
 Running
@@ -157,8 +160,10 @@ enabled.  The default Finit rescue mode configuration is installed into
 
 By default the a root shell, without login, is started.
 
-> **Note:** in this mode `initctl` will not work.  Use the `-f` flag to
-> force `reboot`, `shutdown`, or `poweroff`.
+> [!IMPORTANT]
+> In rescue mode `initctl` will not work, the same goes for `reboot`,
+> `shutdown`, and `poweroff` commands, provided they are the Finit
+> versions of these commands.  Use the `-f` flag to force the action.
 
 
 Debugging
@@ -187,8 +192,9 @@ kernel usually reboots: `configure --enable-emergency-shell`.  However,
 the behavior of Finit is severely limited when this is enabled, so use
 it only for debugging start up issues when Finit crashes.
 
-**NOTE:** Neither of these options should be enabled on production
-         systems since they can potentially give a user root access.
+> [!CAUTION]
+> None of these options should be enabled on production systems since
+> they can potentially give a user root access.
 
 
 [1]:       ftp://troglobit.com/finit/finit-4.3.tar.gz

doc/cmdline.md

@@ -4,10 +4,11 @@ Tips & Tricks with the kernel cmdline
 This document summarizes the different boot parameters that can be
 passed on the Linux kernel command line.  Not limited to Finit.
 
-The `bool` setting is one of `on, off, true false, 1, 0`.
+> [!IMPORTANT]
+> Remember to use `--` to separate kernel parameters from parameters to
+> init.  E.g., `init=/sbin/finit -- finit.debug rescue`
 
-> **NOTE:** remember to use `--` to separate kernel parameters from
-> parameters to init.  E.g., `init=/sbin/finit -- finit.debug rescue`
+The `bool` setting is one of `on, off, true false, 1, 0`.
 
 * `debug`: Enable kernel debug.  Debug messages are printed to the
    console until Finit starts up, unless `loglevel=7` (below) is used.
@@ -30,7 +31,8 @@ The `bool` setting is one of `on, off, true false, 1, 0`.
   Very useful for selecting different boot modes, e.g. manufacturing test,
   firmware upgrade, or rescue mode.
 
-  > Note: `<boot/...>` conditions cannot be cleared with `initctl`!
+> [!NOTE]
+> `<boot/...>` conditions cannot be cleared with `initctl`!
 
 * `finit.config=/path/to/alternative/finit.conf`: override the
   compile-time bootstrap config file, default:

doc/conditions.md

@@ -47,9 +47,10 @@ both the `pid/setupd` *and* `pid/zebra` conditions are satisfied.  A
 `pid/` condition is satisfied by the corresponding service's PID file
 being created, i.e., the service's default readiness notification.
 
-**NOTE:** Conditions also stop services when a condition is no longer
-  asserted.  I.e., if the Zebra process above stops or restarts, netd
-  will also stop or restart.
+> [!IMPORTANT]
+> Conditions also stop services when a condition is no longer asserted.
+> I.e., if the `zebra` process above stops or restarts, `netd` will also
+> stop or restart.
 
 Another example is `dropbear`, it does not support `SIGHUP`, but we can
 also see optional sourcing of arguments from an environment file:
@@ -106,11 +107,16 @@ on this, see [Internals](#internals).)  Thus, after a reconfiguration it
 is up to the "owner" of the condition to convey the new (or possibly
 unchanged) state of it.
 
-> **Note:** For `pid/` conditions it is expected that services "touch"
->           or recreate their PID file on `SIGHUP`.
-
 Static (one-shot) conditions, like `usr/`, never enter the `flux` state.
 
+> [!IMPORTANT]
+> For `pid/` conditions it is expected that the service reassert, i.e.,
+> "touch" or recreate, their PID file on `SIGHUP`.  This can be done by
+> calling `utimensat()` on the PID file.  Provided, of course, that the
+> service supports reloading on `SIGHUP`, otherwise it will be restarted
+> by Finit when they instead exit on the signal.  For such services, use
+> `<!>` to tell Finit the service does not support `SIGHUP`.
+
 
 Built-in Conditions
 -------------------
@@ -171,9 +177,10 @@ Built-in conditions:
 - `boot/arg`
 - `dev/node` and `dev/dir/node`
 
-**Note:** `up` means administratively up, the interface flag `IFF_UP`.
-  `running` is the `IFF_RUNNING` flag, meaning operatively up.  The
-  difference is that `running` tells if the NIC has link.
+> [!NOTE]
+> Here, `up` means administratively up, the interface flag `IFF_UP`.
+> `running` is the `IFF_RUNNING` flag, meaning operatively up.  The
+> difference is that `running` tells if the NIC has link.
 
 
 Composition
@@ -205,8 +212,9 @@ the service stanza for the daemon.  It is far from optimal since any
 synchronization of depending services may fail due to the daemon not
 having reinitialized/created their IPC sockets, or similar.
 
-> **Note:** in versions of Finit prior to v4, the PID conditions were
->           called 'svc' conditions, and they were far more complex.
+> [!NOTE]
+> In versions of Finit prior to v4, the PID conditions were called 'svc'
+> conditions, and they were far more complex.
 
 
 Debugging