From 91ea846a6f05e9a57b2b3bc3b56a94e0026c5618 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Sat, 4 May 2019 19:57:36 +0000
Subject:  Add -n and -N options to s6-l-i and s6-l-i-m

---
 doc/s6-linux-init-maker.html | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

(limited to 'doc/s6-linux-init-maker.html')

diff --git a/doc/s6-linux-init-maker.html b/doc/s6-linux-init-maker.html
index 6c52d32..02fd15d 100644
--- a/doc/s6-linux-init-maker.html
+++ b/doc/s6-linux-init-maker.html
@@ -59,6 +59,7 @@ machine</em>. If it is not the case, the system will fail to boot.
        [ -e <em>initial_envvar</em> ] ... \
        [ -q <em>finalsleeptime</em> ] \
        [ -D <em>initdefault</em> ] \
+       [ -n | -N ]
        [ -U <em>utmp_user</em> ] \
        <em>dir</em>
 </pre>
@@ -169,7 +170,7 @@ is defined. </li> <p />
  <li> <tt>-1</tt>&nbsp;: make it so that all the messages that are
 sent to the catch-all logger (i.e. all the error messages that are not
 caught by a dedicated logger, as well as the output from <em>rc.init</em>,
-<em>runlevel</em> and <em>rc.shutdown</em>,
+<em>runlevel</em> and <em>rc.shutdown</em>)
 are also copied to <tt>/dev/console</tt>. (Timestamps are not
 copied to <tt>/dev/console</tt>.) This is generally useful to
 debug a system at a glance, but if a failing program keeps sending
@@ -264,6 +265,36 @@ sysvinit behaviour) or <tt>default</tt> (OpenRC behaviour). Default is
 command line, it will be interpreted as the runlevel to boot the system
 on, and will override the default given here. </li> <p />
 
+ <li> <tt>-n</tt>&nbsp;: at boot time, assume that a tmpfs is already
+present on <tt>/run</tt> (or the argument that was given to the
+<tt>--tmpfsdir</tt> configure option at build time) and that its
+contents are essential. Instead of unmounting <tt>/run</tt> then
+mounting a tmpfs on it, <a href="s6-linux-init.html">s6-linux-init</a>
+will simply remount <tt>/run</tt>. This option is useful when
+s6-linux-init is used on a distribution that imposes its initramfs
+and said initramfs writes data to <tt>/run</tt> that is then used
+by the distribution's initialization scripts. (An initramfs should
+normally be transparent and leave no trace in the filesystem;
+unfortunately, a lot of distributions do not care.) By default,
+<tt>/run</tt> will be unmounted at boot time (just in case), and
+then a tmpfs will be mounted on it. <strong>Do not</strong> use
+this option if you are not sure: failure to remount <tt>/run</tt>
+will cause init to die and the kernel to panic. This option is
+incompatible with the <tt>-N</tt> option. </li> <p />
+
+ <li> <tt>-N</tt>&nbsp;: at boot time, do not perform
+mounting/unmounting/remounting on <tt>/run</tt> (or the <em>tmpfsdir</em>
+declared at build time) <strong>at all</strong>. By default,
+a tmpfs is mounted on <tt>/run</tt> at boot time. This option is
+useful when s6-linux-init is used to boot on an initramfs that
+will remain the de facto rootfs of the system (which is the case
+for instance in certain live CDs or certain embedded devices), in
+which case the rootfs is already read-write and in RAM and mounting
+an additional tmpfs is unnecessary. <strong>Do not</strong> use this
+option if your rootfs is read-only: failure to write to <tt>/run</tt>
+will cause init to die and the kernel to panic. This option is
+incompatible with the <tt>-n</tt> option. </li> <p />
+
  <li> <tt>-U</tt>&nbsp;<em>utmp_user</em>&nbsp;: this option is only
 available when the s6-linux-init package has been built with the
 <tt>--enable-utmps</tt> configure option, that enables support for the
-- 
cgit v1.2.3