commit a73c94f6adf37f2f7af655b016d8f03209ecdc46
parent a37ea0818a0889fbf36a4fbe918929b53fb0f7c6
Author: Laurent Bercot <ska-skaware@skarnet.org>
Date: Wed, 11 Jan 2023 12:36:30 +0000
Doc fixes
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat:
3 files changed, 15 insertions(+), 19 deletions(-)
diff --git a/doc/instances.html b/doc/instances.html
@@ -16,7 +16,7 @@
<a href="//skarnet.org/">skarnet.org</a>
</p>
-<h1> Dynamic instantiation under s6 </h1>
+<h1> Dynamic instantiation </h1>
<p>
An <em>instanced service</em> is a parameterized service that you want to
@@ -50,8 +50,8 @@ instanced services.
<li> Write a template for a service directory that would run under
<a href="s6-supervise.html">s6-supervise</a>.
The <tt>run</tt> script should take the name of the instance as its
-first argument; the <tt>finish</tt> script should take the name of the
-instance as its third argument. </li>
+first argument; the <tt>finish</tt> script, if present, should take the name
+of the instance as its third argument. </li>
<li> Call the <a href="s6-instance-maker.html">s6-instance-maker</a> program
with this template as first argument, and a path <em>dir</em> as second
argument. <a href="s6-instance-maker.html">s6-instance-maker</a> will create
@@ -101,10 +101,10 @@ or not depending on the given options. </li>
around <a href="s6-svc.html">s6-svc</a> on <tt>instance/<em>name</em></tt>. </li>
<li> <a href="s6-instance-status.html">s6-instance-status</a> is syntactic sugar
around <a href="s6-svstat.html">s6-svstat</a> on <tt>instance/<em>name</em></tt>. </li>
- <li> <a href="s6-instance-list.html">s6-instance-list</a> is roughly equivalent
-to <code>ls -1 instance </code>. </li>
<li> <a href="s6-instance-delete.html">s6-instance-delete</a> is syntactic sugar
around <a href="s6-svunlink.html">s6-svunlink</a> on <tt>instance/<em>name</em></tt>. </li>
+ <li> <a href="s6-instance-list.html">s6-instance-list</a> is roughly equivalent
+to <code>ls -1 instance </code>. </li>
</ul>
<h2> Notes </h2>
diff --git a/doc/s6-instance-list.html b/doc/s6-instance-list.html
@@ -52,7 +52,7 @@ up or down; if they've been created and not deleted, they're printed. </li>
<ul>
<li> The list is unsorted, the instance names are printed in an unspecified order. </li>
<li> You can use s6-instance-list to script commands that handle sets of instances.
-For instance, to get the status of all the instances of a given service, you could write:
+For example, to get the status of all the instances of a given service, you could write:
<code> for i in `s6-instance-list <em>service</em>` ; do printf "%s: " $i ; s6-instance-status <em>service</em> $i ; done </code> </li>
</ul>
diff --git a/doc/s6-instance-maker.html b/doc/s6-instance-maker.html
@@ -59,12 +59,10 @@ each running a copy of the service directory given in <em>template</em>.
<p>
s6-instance-maker is an <em>offline</em> tool: it is run before you need
instances. Once the created service directory is live, i.e. there is a
-supervisor running on it, then you can create, delete, or control
-individual instances via the
-<a href="s6-instance-create.html">s6-instance-create</a>,
-<a href="s6-instance-delete.html">s6-instance-delete</a> and
-<a href="s6-instance-control.html">s6-instance-control</a> <em>online</em>
-tools, that work with active services.
+supervisor running on it, then you can create and delete individual instances via the
+<a href="s6-instance-create.html">s6-instance-create</a> and
+<a href="s6-instance-delete.html">s6-instance-delete</a>
+<em>online</em> tools, that work with active services.
</p>
<h2> Exit codes </h2>
@@ -167,20 +165,18 @@ This argument will be the name of the instance, as provided by the
The service is logged: its stderr and stdout are piped to an
<a href="s6-log.html">s6-log</a> process running as <em>loguser</em> and
writing to the <em>logdir</em> directory. This logger is the catch-all logger
-for the supervision tree owned by <em>user</em>; it is recommended to make
-<em>loguser</em> distinct from <em>user</em>, and to have <em>logdir</em>
-in a place that is <strong>not</strong> under the control of <em>user</em>.
-If <em>user</em> wants to keep control of their logs, they can declare a
-logger for each of their services.
+for all the instances and the supervision tree hosting them. If <em>user</em>
+and <em>loguser</em> are provided, it is recommended to make them distinct
+from each other.
</p>
<p>
- If <em>template</em> has a <em>log</em> subdirectory, then each instance
+ Additionally, if <em>template</em> has a <em>log</em> subdirectory, then each instance
will have its own dedicated logger. The <tt>run</tt> and <tt>finish</tt>
scripts for the logger of an instance named <em>name</em> will be called
with an additional argument of <tt><em>name</em>/log</tt>. They should
make use of this, to ensure loggers are properly differentiated between
-instances: for instance, it is not possible to run several
+instances: for example, it is not possible to run several
<a href="s6-log.html">s6-log</a> processes on the same log directory,
so an instance logger script containing an invocation of s6-log on a fixed
logdir will fail as soon as there are 2 instances.
