From b0fe68c13b04af8c098d53ea999bba6b7395163d Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Wed, 16 Sep 2020 12:04:55 +0000 Subject: Documentation fixes, by flexibeast --- doc/ftrig.html | 8 ++++---- doc/index.html | 32 ++++++++++++++++---------------- doc/libs6/accessrules.html | 8 ++++---- doc/libs6/ftrigr.html | 8 ++++---- doc/libs6/s6-fdholder.html | 2 +- doc/libs6/s6-ftrigrd.html | 8 ++++---- doc/libs6/s6lock.html | 8 ++++---- doc/libs6/s6lockd.html | 12 ++++++------ doc/localservice.html | 2 +- doc/overview.html | 6 +++--- doc/s6-accessrules-cdb-from-fs.html | 4 ++-- doc/s6-accessrules-fs-from-cdb.html | 2 +- doc/s6-connlimit.html | 4 ++-- doc/s6-envdir.html | 2 +- doc/s6-envuidgid.html | 8 ++++---- doc/s6-fdholder-daemon.html | 6 +++--- doc/s6-fdholder-delete.html | 4 ++-- doc/s6-fdholder-errorcodes.html | 6 +++--- doc/s6-fdholder-getdump.html | 12 ++++++------ doc/s6-fdholder-list.html | 4 ++-- doc/s6-fdholder-retrieve.html | 8 ++++---- doc/s6-fdholder-setdump.html | 4 ++-- doc/s6-fdholder-store.html | 4 ++-- doc/s6-fdholder-transferdump.html | 2 +- doc/s6-fdholderd.html | 16 ++++++++-------- doc/s6-ftrig-listen.html | 4 ++-- doc/s6-ftrig-listen1.html | 4 ++-- doc/s6-ftrig-wait.html | 4 ++-- doc/s6-ioconnect.html | 4 ++-- doc/s6-ipcclient.html | 2 +- doc/s6-ipcserver-access.html | 6 +++--- doc/s6-ipcserver-socketbinder.html | 4 ++-- doc/s6-ipcserver.html | 4 ++-- doc/s6-log.html | 28 ++++++++++++++-------------- doc/s6-svc.html | 2 +- doc/s6-svscan-1.html | 4 ++-- doc/s6-svscan.html | 6 +++--- doc/s6-svscanctl.html | 2 +- doc/s6-svstat.html | 4 ++-- doc/scandir.html | 6 +++--- doc/servicedir.html | 6 +++--- doc/socket-activation.html | 2 +- doc/why.html | 20 +++++++++++--------- 43 files changed, 147 insertions(+), 145 deletions(-) diff --git a/doc/ftrig.html b/doc/ftrig.html index 6d26eeb..c8f168d 100644 --- a/doc/ftrig.html +++ b/doc/ftrig.html @@ -73,7 +73,7 @@ it's not handling an event, and only wake up when needed. Of course, the problem of notification is that it's often more difficult to implement. Notification frameworks are generally more complex, involving lots of asynchronism; polling is widely used -because +because it's easy.

@@ -86,11 +86,11 @@ notify process A. @@ -107,7 +107,7 @@ program does the same thing more efficiently.

Notes

Options

@@ -54,7 +54,7 @@ wrong socket, for instance).
  • 1: the server denied the operation. The meaning of the error messages is explained here.
  • 100: wrong usage.
    • -
  • 111: system call failed - that includes attempting to connect to a +
  • 111: system call failed - this includes attempting to connect to a nonexistent socket, or one where no s6-fdholderd daemon is listening.
    • diff --git a/doc/s6-fdholder-retrieve.html b/doc/s6-fdholder-retrieve.html index a58d64e..3edc1fb 100644 --- a/doc/s6-fdholder-retrieve.html +++ b/doc/s6-fdholder-retrieve.html @@ -21,8 +21,8 @@

    s6-fdholder-retrieve connects to a fd-holding daemon listening on a -Unix domain socket, and retrieves a file descriptor from that -daemon, then executes a program with that file descriptor as the +Unix domain socket, and retrieves a file descriptor from this +daemon, then executes a program with this file descriptor as the program's standard input.

    @@ -63,7 +63,7 @@ wrong socket, for instance).
  • 1: the server denied the operation. The meaning of the error messages is explained here.
  • 100: wrong usage.
    • -
  • 111: system call failed - that includes attempting to connect to a +
  • 111: system call failed - this includes attempting to connect to a nonexistent socket, or one where no s6-fdholderd daemon is listening.
    • @@ -77,7 +77,7 @@ daemon is listening.

    will retrieve a file descriptor stored under the MYSOCKET identifier in the s6-fdholderd daemon listening on the /service/fdholderd/s -socket, and execute into s6-ipcserverd cat with that file +socket, and execute into s6-ipcserverd cat with this file descriptor as stdin. In this case, if MYSOCKET referred to a Unix domain socket, s6-ipcserverd will then accept client connections on it and spawn a cat program for every diff --git a/doc/s6-fdholder-setdump.html b/doc/s6-fdholder-setdump.html index 297306c..df8c4b5 100644 --- a/doc/s6-fdholder-setdump.html +++ b/doc/s6-fdholder-setdump.html @@ -56,7 +56,7 @@ wrong socket, for instance).

  • 1: the server denied the operation. The meaning of the error messages is explained here.
  • 100: wrong usage.
    • -
  • 111: system call failed - that includes attempting to connect to a +
  • 111: system call failed - this includes attempting to connect to a nonexistent socket, or one where no s6-fdholderd daemon is listening.
    • @@ -69,7 +69,7 @@ already open in the s6-fdholder-setdump program; also, s6-fdholder- should have certain environment variables that describe that set of file descriptors. The format of the environment is the same as the one set by s6-fdholder-getdump. -
  • Setting the whole state of a s6-fdholderd daemon requires specific +
  • Setting the whole state of an s6-fdholderd daemon requires specific privileges. Make sure you properly configure the s6-fdholderd access rights so your client can perform that operation.
    • diff --git a/doc/s6-fdholder-store.html b/doc/s6-fdholder-store.html index d0c3197..ceff696 100644 --- a/doc/s6-fdholder-store.html +++ b/doc/s6-fdholder-store.html @@ -47,7 +47,7 @@ By default, fd is 0 (i.e. the program's stdin will be stored).
  • -T fdtimeout : the descriptor is stored with an expiration time of fdtimeout milliseconds, which means the s6-fdholderd daemon will close and get rid of -the descriptor after that time. By default, fdtimeout is 0, which +the descriptor after this time. By default, fdtimeout is 0, which means infinite - no expiration time.
  • -t timeout : if the operation cannot be processed in timeout milliseconds, then fail with an error message. @@ -63,7 +63,7 @@ wrong socket, for instance).
  • 1: the server denied the operation. The meaning of the error messages is explained here.
  • 100: wrong usage.
    • -
  • 111: system call failed - that includes attempting to connect to a +
  • 111: system call failed - this includes attempting to connect to a nonexistent socket, or one where no s6-fdholderd daemon is listening.
    • diff --git a/doc/s6-fdholder-transferdump.html b/doc/s6-fdholder-transferdump.html index da74069..f0a0097 100644 --- a/doc/s6-fdholder-transferdump.html +++ b/doc/s6-fdholder-transferdump.html @@ -65,7 +65,7 @@ is explained here.
  • 2: the destination server denied the operation. The meaning of the error messages is explained here.
  • 100: wrong usage.
    • -
  • 111: system call failed - that includes attempting to connect to a +
  • 111: system call failed - this includes attempting to connect to a nonexistent socket, or one where no s6-fdholderd daemon is listening.
    • diff --git a/doc/s6-fdholderd.html b/doc/s6-fdholderd.html index 4b4794b..0278616 100644 --- a/doc/s6-fdholderd.html +++ b/doc/s6-fdholderd.html @@ -84,7 +84,7 @@ It is impossible to set it higher than the number of files that can be opened by the s6-fdholderd process, minus a few descriptors needed for correct operation. Before running s6-fdholderd, make sure to properly adjust the -number +number of openable files of the current process.
  • -t clienttimeout : disconnect a client if it's in the middle of an operation and it has not written or read any @@ -96,7 +96,7 @@ before exiting after receiving a SIGTERM. By default, lameducktimeout is 0, which means infinite.
  • -x rulesfile : read access rights configuration from -CDB +CDB file rulesfile.
  • -i rulesdir : read access rights configuration from the filesystem in directory rulesdir.
    • @@ -148,7 +148,7 @@ it is possible to reuse the same identifier. s6-fdholder-daemon), it is necessary to configure it. This is done by a series of rules, or ruleset, stored in either a rulesfile in the -CDB format, +CDB format, or in a rulesdir, i.e. a directory in the filesystem following a certain format. s6-fdholderd will refuse to run if neither the -i nor the -x option has been provided. @@ -210,8 +210,8 @@ file named S6_FDHOLDER_STORE_REGEX is found is the env/ subdirectory of one of the subdirectories checked by s6_accessrules_keycheck_uidgid. This file should contain a single line, which will be interpreted as an -extended -regular expression by s6-fdholderd; the regular expression describes the +Extended +Regular Expression by s6-fdholderd; the regular expression describes the set of identifiers that the client is allowed to use to store file descriptors. For instance, ^unix:/tmp/ indicates that a client that matches this rule will be allowed to store or delete file descriptors @@ -222,8 +222,8 @@ file named S6_FDHOLDER_RETRIEVE_REGEX is found is the env/ subdirectory of one of the subdirectories checked by s6_accessrules_keycheck_uidgid. This file should contain a single line, which will be interpreted as an -extended -regular expression by s6-fdholderd; the regular expression describes the +Extended +Regular Expression by s6-fdholderd; the regular expression describes the set of identifiers that the client is allowed to use to retrieve file descriptors. For instance, ^unix:/tmp/ indicates that a client that matches this rule will be allowed to retrieve file descriptors that are @@ -253,7 +253,7 @@ to a dedicated uid that is only used to perform dump transfers.

    Configuration examples

    - Assuming you want to run a s6-fdholderd daemon in the + Assuming you want to run an s6-fdholderd daemon in the /service/fdholder directory with the -i rules option, you should:

    diff --git a/doc/s6-ftrig-listen.html b/doc/s6-ftrig-listen.html index 5726fa6..76adcc2 100644 --- a/doc/s6-ftrig-listen.html +++ b/doc/s6-ftrig-listen.html @@ -40,8 +40,8 @@ to fifodir2 with the regexp regexp2, and so on.
  • It then forks and exec prog... with all its arguments
  • It waits for the series of events received on fifodir-i to match regexp-i, The regexp-i must be -extended -regular expressions.
    • +Extended +Regular Expressions.
  • When the series of read events matches the regexps, s6-ftrig-listen exits 0.
    • diff --git a/doc/s6-ftrig-listen1.html b/doc/s6-ftrig-listen1.html index e780b4e..c2349f1 100644 --- a/doc/s6-ftrig-listen1.html +++ b/doc/s6-ftrig-listen1.html @@ -40,8 +40,8 @@ started after there is a listener for those events.
  • It then forks and exec prog... with all its arguments
  • It waits for the series of events received on fifodir to match regexp. regexp must be an -extended -regular expression.
    • +Extended +Regular Expression.
  • When the series of read events matches regexp, s6-ftrig-listen1 prints the last event it received (one byte) to stdout, then exits 0.
    • diff --git a/doc/s6-ftrig-wait.html b/doc/s6-ftrig-wait.html index daacfb2..fe7e585 100644 --- a/doc/s6-ftrig-wait.html +++ b/doc/s6-ftrig-wait.html @@ -33,8 +33,8 @@ waits for a pattern of events to occur on this fifodir.
  • s6-ftrig-wait subscribes to fifodir
  • It waits for the series of events received on fifodir to match regexp. regexp must be an -extended -regular expression.
    • +Extended +Regular Expression.
  • When the series of read events matches regexp, s6-ftrig-wait prints the last event it received (one byte) to stdout, then exits 0.
    • diff --git a/doc/s6-ioconnect.html b/doc/s6-ioconnect.html index 1ea9a5c..2135956 100644 --- a/doc/s6-ioconnect.html +++ b/doc/s6-ioconnect.html @@ -63,7 +63,7 @@ for writing to correctly transmit an EOF. @@ -43,7 +43,7 @@ as its standard input.

    syslog is slow, it's unsafe, and it's incomplete. The only reason people use it is because it's historical, it exists, and there hasn't been any serious alternative yet, except maybe -multilog, which +multilog, which s6-log improves upon.

    @@ -502,7 +502,7 @@ system console. -

    What does s6-log have to do with all this ?

    +

    What does s6-log have to do with all this?

    @@ -524,7 +524,7 @@ not waste resources. is as powerful as a traditional syslogd.

  • s6-log can log to a RAM filesystem and thus is suitable as a catch-all logger. Clever tricks like Upstart's logd or daemontools' -readproctitle +readproctitle are just that: tricks. s6-log gives a unified interface to all of your system's loggers.
    • diff --git a/doc/s6-svc.html b/doc/s6-svc.html index c1e617f..cce152a 100644 --- a/doc/s6-svc.html +++ b/doc/s6-svc.html @@ -150,7 +150,7 @@ process is s6-log, this triggers a log rotation.

    @@ -67,7 +67,7 @@ never wakes up unless it receives a command via s6-svscanctl.

  • System V init is process 1, so no problem here.
  • Integrated init systems, by definition, provide a process 1.
  • daemontools was not designed to take over init, although -it can be made to work with +it can be made to work with enough hacking skills. Same thing with daemontools-encore.
  • runit provides an init functionality, but the mechanism is separate from the supervision itself; the runit process, not the @@ -102,7 +102,9 @@ process 1 against libdbus. This is insane. Process 1 should be absolutely stable, it should be guaranteed to never crash, so the whole of its source code should be under control. At Upstart's level of complexity, those goals are outright impossible to achieve, -so this approach is flawed by design.
    • +so this approach is flawed by design. It is a shame, because the concepts +and ideas behind Upstart are good and sound; it's the +implementation choices that are its downfall.
  • launchd suffers from the same kind of problems. Example: Services running under launchd must be configured using @@ -163,10 +165,10 @@ and instantly respond to commands they may receive. s6-supervise has even been implemented as a full deterministic finite automaton, to ensure it always does the right thing under any circumstance. Other supervision suites do not achieve that for now.
    • -
  • daemontools' svscan +
  • daemontools' svscan maintains an open pipe between a daemon and its logger, so even if the daemon, the logger, and both -supervise processes +supervise processes die, the pipe is still the same so no logs are lost, ever, unless svscan itself dies.
  • runit has only one supervisor, runsv, -- cgit v1.2.3