From ea03dcd75d336ffcec2861c95461bd2e78da3ffb Mon Sep 17 00:00:00 2001
From: Laurent Bercot
Date: Fri, 26 Apr 2019 16:42:04 +0000
Subject: Doc revision
---
doc/index.html | 18 ++++++------------
doc/overview.html | 12 ++++++------
doc/s6-linux-init-logouthookd.html | 2 +-
doc/s6-linux-init-maker.html | 7 +++++++
doc/s6-linux-init-shutdownd.html | 6 +++---
doc/s6-linux-init.html | 4 ++--
doc/why.html | 2 +-
7 files changed, 26 insertions(+), 25 deletions(-)
diff --git a/doc/index.html b/doc/index.html
index 1b4dda6..a428ccf 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -20,7 +20,7 @@
What is it ?
- s6-linux-init is a set of minimalistic tools to create a
+ s6-linux-init is a set of minimalistic tools used to create a
s6-based init
system, including a /sbin/init binary, on a Linux kernel.
@@ -54,20 +54,12 @@ kernel command line
LSB specification
- Getting started
-
-
- Please read the documentation for the
-s6-linux-init-maker program
-carefully, but if you're impatient, you can also read this
-quickstart guide.
-
-
@@ -168,7 +160,7 @@ the previous versions of s6-linux-init and the current one.
The s6-linux-init-shutdownd program
The s6-linux-init-telinit program
The s6-linux-init-logouthookd program
-The s6-linux-init-umountall program
+The s6-linux-init-echo program
The s6-linux-init-umountall program
@@ -176,7 +168,9 @@ the previous versions of s6-linux-init and the current one.
- s6-linux-init is discussed on the
-skaware mailing-list.
+skaware and
+supervision
+mailing-lists.
- There is a #s6 IRC channel on Freenode. Sometimes people
are there and even answer questions.
diff --git a/doc/overview.html b/doc/overview.html
index e1f3b31..8f19bcd 100644
--- a/doc/overview.html
+++ b/doc/overview.html
@@ -26,16 +26,16 @@ following:
- - Binaries, that are typically installed in /bin
+
- Binaries, that are typically installed in /bin:
- s6-linux-init-maker is the main
program of the package and is used to create /sbin/init scripts
and their supporting environment depending on configuration parameters
given on its command line.
- s6-linux-init-hpr is an
-implementation of the sysv halt, poweroff and reboot
+implementation of the SysV halt, poweroff and reboot
commands; s6-linux-init-telinit
-is an implementation of the sysv telinit command; and
+is an implementation of the SysV telinit command; and
s6-linux-init-shutdown
is an implementation of the
shutdown
@@ -44,8 +44,8 @@ implementation of stage 1 /sbin/init, but it needs to be
given command-line options in order to do what the user has chosen.
An invocation of s6-linux-init-maker
will create proper wrappers for all those commands, named after their
-short sysv names; the wrappers are directly usable as turnkey replacements
-for sysv commands.
+short SysV names; the wrappers are directly usable as turnkey replacements
+for SysV commands.
- Other binaries are support binaries, not meant to be called
directly by the user. They are called internally, in scripts
created by a
@@ -63,7 +63,7 @@ page for details.
- Skeleton scripts, installed by default in
/etc/s6-linux-init/skel; that location can be changed at build
time via the --skeldir configure option. At
-s6-linux-init-maker, the scripts are copied from the skeleton
+s6-linux-init-maker invocation time, the scripts are copied from the skeleton
directory to the scripts subdirectory of the directory created
by s6-linux-init-maker, and the copy is meant to be edited
by the user. The skeleton scripts are commented and examples of
diff --git a/doc/s6-linux-init-logouthookd.html b/doc/s6-linux-init-logouthookd.html
index 34f5bd8..51edca1 100644
--- a/doc/s6-linux-init-logouthookd.html
+++ b/doc/s6-linux-init-logouthookd.html
@@ -76,7 +76,7 @@ and when it happens, the user's utmp record will automatically be cleaned up.
- The local service
implementing logouthook support is automatically created at boot time when the
-L option has been given to
-s6-linux-init-maker. Client-side, though,
+s6-linux-init-maker. Client-side, though,
the various login programs must be patched at the source level.
diff --git a/doc/s6-linux-init-maker.html b/doc/s6-linux-init-maker.html
index 45284ab..161ce6b 100644
--- a/doc/s6-linux-init-maker.html
+++ b/doc/s6-linux-init-maker.html
@@ -357,6 +357,13 @@ the machine it has been created on. Pre-creating init directories for
other machines is not supported.
+
+ After booting, basedir should remain untouched during the
+lifetime of the machine, because the machine state change and shutdown
+procedures will look for data in basedir. New invocations of
+s6-linux-init-maker should use a different basedir.
+
+
The difficult parts of
running
diff --git a/doc/s6-linux-init-shutdownd.html b/doc/s6-linux-init-shutdownd.html
index f4cf8a0..c601466 100644
--- a/doc/s6-linux-init-shutdownd.html
+++ b/doc/s6-linux-init-shutdownd.html
@@ -42,7 +42,7 @@ created the shutdownd service.
When this script exits, s6-linux-init-shutdownd kills all
processes, first with a SIGTERM, then (after the grace time specified by
the shutdown command) with a SIGKILL.
- It then runs the automatically-generated stage 4 script,
+ It then runs an automatically-generated script (called stage 4),
which unmounts the file systems and halts, powers off or reboots the
machine.
@@ -58,8 +58,8 @@ machine.
- -c basedir : look for the
-stage3 and stage4 scripts in the basedir
-directory. Default is /etc/s6-linux-init.
+rc.shutdown script in the basedir/scripts
+directory. Default is /etc/s6-linux-init/current.
- -g gracetime : if the shutdown command
does not specify a grace time between the SIGTERM and the SIGKILL, use
gracetime milliseconds. Default is 3000.
diff --git a/doc/s6-linux-init.html b/doc/s6-linux-init.html
index a4bb636..e8ab361 100644
--- a/doc/s6-linux-init.html
+++ b/doc/s6-linux-init.html
@@ -106,14 +106,14 @@ it uses initdefault.
It also makes the catch-all logger's fifo its stderr.
It execs into s6-svscan
-with /run/service as its scandir (or tmpfsdir/service) .
+with /run/service as its scandir (or tmpfsdir/service).
- s6-svscan
spawns the early services that are defined in
basedir/run-image/service, and have been copied into
/run/service (or tmpfsdir/service).
- One of those early services is s6-svscan-log, which is
-the catch-all logger. When this service is up, s6-linux-init's
+the catch-all logger. When this service is up, s6-linux-init's
child unblocks.
- The child execs into basedir/scripts/rc.init.
The first argument to rc.init is the chosen runlevel. The kernel
diff --git a/doc/why.html b/doc/why.html
index 2c200c5..43c7f84 100644
--- a/doc/why.html
+++ b/doc/why.html
@@ -52,7 +52,7 @@ package.
As explained in
this
-presentation">, an init system is made of four parts:
+presentation
, an init system is made of four parts:
--
cgit v1.2.3