Break out building and bootstrap to separate files

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>

doc/bootstrap.md

@@ -0,0 +1,52 @@
+Bootstrap
+=========
+
+1. Populate `/dev`
+2. Parse `/etc/finit.conf`
+3. Load all `.so` plugins
+4. Remount/Pivot `/` to get R+W
+5. Call 1st level hooks, `HOOK_ROOTFS_UP`
+6. Mount `/etc/fstab` and swap, if available
+7. Cleanup stale files from `/tmp/*` et al
+8. Enable SysV init signals
+9. Call 2nd level hooks, `HOOK_BASEFS_UP`
+10. Start all 'S' runlevel tasks and services
+11. Load kernel parameters from `/etc/sysctl.conf`
+12. Set hostname and bring up loopback interface
+13. Call `network` script, if set in `/etc/finit.conf`
+14. Call 3rd level hooks, `HOOK_NETWORK_UP`
+15. Switch to the configured runlevel from `/etc/finit.conf`, default 2.
+    At every runlevel change all `*.conf` files in `/etc/finit.d/` are
+    (re)loaded and new services, tasks, and blocking run commands are
+    started.  Provided they are allowed in the new runlevel and all of
+    their conditions, if any, are set.
+16. Call 4th level hooks, `HOOK_SVC_UP`
+17. If `runparts <DIR>` is set, [run-parts(8)][] is called on `<DIR>`
+18. Call `/etc/rc.local`, if it exists and is an executable shell script
+19. Call 5th level (last) hooks, `HOOK_SYSTEM_UP`
+20. Start TTYs defined in `/etc/finit.conf`, or rescue on `/dev/console`
+
+In (10) and (15) tasks and services defined in `/etc/finit.conf` are
+started.  Remember, all `service` and `task` stanzas are started in
+parallel and `run` in sequence, and in the order listed.  Hence, to
+emulate a SysV `/etc/init.d/rcS` one could write a long file with only
+`run` statements.
+
+Notice the five hook points that are called at various point in the
+bootstrap process.  This is where plugins can extend the boot in any way
+they please.
+
+For instance, at `HOOK_BASEFS_UP` a plugin could read an XML file from a
+USB stick, convert/copy its contents to the system's `/etc/` directory,
+well before all 'S' runlevel tasks are started.  This could be used with
+system images that are created read-only and all configuration is stored
+on external media.
+
+
+[run-parts(8)]: http://manpages.debian.org/cgi-bin/man.cgi?query=run-parts
+
+<!--
+  -- Local Variables:
+  -- mode: markdown
+  -- End:
+  -->

doc/build.md

@@ -0,0 +1,99 @@
+Building
+========
+
+Finit comes with a traditional configure script to control features and
+optional plugins to enable.  It does however depend on two external
+libraries that provide some frog DNA needed:
+
+- [libuEv][]
+- [libite][] (-lite)
+
+Like most free/open source software that uses `configure` they deafult
+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
+
+Below are a few of the main switches to
+configure:
+
+* `--disable-inetd`: Disable the built-in inetd server.
+
+* `--enable-embedded`: Target finit for BusyBox getty and mdev instead
+  of a standard Linux distribution with GNU tools and udev.
+
+* `--enable-rw-rootfs`: Most desktop and server systems boot with the
+  root file stystem read-only.  With this setting Finit will remount it
+  as read-write early at boot so the `bootmisc.so` plugin can run.
+  Usually not needed on embedded systems.
+
+* `--enable-static`: Build Finit statically.  The plugins will be
+  built-ins (.o files) and all external libraries, except the C library
+  will be linked statically.
+
+* `--enable-alsa-utils`: Enable the optional `alsa-utils.so` sound plugin.
+
+* `--enable-dbus`: Enable the optional D-Bus `dbus.so` plugin.
+
+* `--enable-lost`: Enable noisy example plugin for `HOOK_SVC_LOST`.
+
+* `--enable-resolvconf`: Enable the `resolvconf.so` optional plugin.
+
+* `--enable-x11-common`: Enable the optional X Window `x11-common.so` plugin.
+
+For more configure flags, see <kbd>./configure --help</kbd>
+
+**Example**
+
+First, unpack the archive:
+
+```shell
+    $ tar xf finit-3.0.tar.xz
+    $ cd finit-3.0/
+```
+
+Then configure, build and install:
+
+```shell
+    $ ./configure --enable-embedded --enable-rw-rootfs --enable-inetd-echo-plugin \
+                  --enable-inetd-chargen-plugin --enable-inetd-daytime-plugin     \
+                  --enable-inetd-discard-plugin --enable-inetd-time-plugin        \
+                  --with-heading="Alpine Linux 3.4" --with-hostname=alpine
+    $ make
+    .
+    .
+    .
+    $ DESTDIR=/tmp/finit make install
+```
+
+In this example the [finit-3.0.tar.xz][1] archive is unpacked to the
+user's home directory, configured, built and installed to a temporary
+staging directory.  The environment variable `DESTDIR` controls the
+destination directory when installing, very useful for building binary
+standalone packages.
+
+To target an embedded Linux system, usally a system that use BusyBox
+tools instead of udev & C:o, add <kbd>--enable-embedded</kbd> to the
+configure command above.  This enables `mdev` instead of `udev` and the
+BusyBox `getty` syntax.  Remember to also change the 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`.
+
+
+[1]:       ftp://troglobit.com/finit/finit-3.0.tar.xz
+[libuEv]:  https://github.com/troglobit/libuev
+[libite]:  https://github.com/troglobit/libite
+
+<!--
+  -- Local Variables:
+  -- mode: markdown
+  -- End:
+  -->