From 543c1405653c48d23e19d03d7c62e9534fc9a110 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Thu, 23 Mar 2017 14:34:16 +0000
Subject:  Don't wait on locks by default (fail instead); add a -b option to
 get the waiting behaviour

 Also fix a few types in s6-rc-compile (unsigned int -> uint32_t for avltree indices)
---
 doc/s6-rc.html | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

(limited to 'doc/s6-rc.html')

diff --git a/doc/s6-rc.html b/doc/s6-rc.html
index 5e851d3..a6e64d9 100644
--- a/doc/s6-rc.html
+++ b/doc/s6-rc.html
@@ -44,9 +44,9 @@ especially when asking for a state change.
 
 <pre>
      s6-rc help
-     s6-rc [ -l live ] [ -a ] [ -u | -d ] list <em>servicenames...</em>
-     s6-rc [ -l live ] [ -a ] [ -u | -d ] listall <em>servicenames...</em>
-     s6-rc [ -l live ] [ -a ] [ -u | -d ] [ -p ] [ -v <em>verbosity</em> ] [ -n <em>dryrunthrottle</em> ] [ -t timeout ] change [ <em>servicenames...</em> ]
+     s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d ] list <em>servicenames...</em>
+     s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d ] listall <em>servicenames...</em>
+     s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d ] [ -p ] [ -v <em>verbosity</em> ] [ -n <em>dryrunthrottle</em> ] [ -t timeout ] change [ <em>servicenames...</em> ]
 </pre>
 
 <ul>
@@ -95,6 +95,14 @@ giving the <tt>--livedir=<em>live</em></tt> option to <tt>./configure</tt>. </li
 the selection. This is useful for instance at
 shutdown time: <tt>s6-rc -da change</tt>
 will stop all services. </li>
+ <li> <tt>-b</tt>&nbsp;: blocking lock. If the service database is currently
+being used by another program, s6-rc will wait until that
+other program has released its lock on the database, then proceed.
+By default, s6-rc fails with an error message if the service database
+is currently in use. The default is the safe behaviour: for instance,
+it will correctly detect and fail nested s6-rc invocations (which are
+an admin error), whereas <tt>s6-rc -b</tt> would deadlock in
+such a case. </li>
 </ul>
 
 <h3> Up or down </h3>
@@ -310,10 +318,13 @@ milliseconds to complete successfully.
 bringing up all its dependencies first (recursively).
 </p>
 
-<pre> s6-rc -ad change </pre>
+<pre> s6-rc -bad change </pre>
 <p>
- Brings down all the currently running services in an orderly manner.
-This is typically run at shutdown time.
+ Waits for any pending program of the s6-rc family to stop using
+the live database and current compiled service database, then
+brings down all the currently running services in an orderly manner.
+This is typically run at shutdown time. (And it's not necessarily
+a bad change!)
 </p>
 
 <pre> s6-rc -l /zork -ua listall <em>myservicebundle</em> </pre>
-- 
cgit v1.2.3