From ded312bcc44704ea16fdfe9fb9f2b46bfd0f537b Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Mon, 27 Mar 2017 14:05:21 +0000
Subject:  Clarify permanent failure API for s6-svwait -r and friends; update
 doc

---
 doc/s6-svlisten.html  | 13 ++++++++++++-
 doc/s6-svlisten1.html | 12 +++++++++++-
 doc/s6-svwait.html    | 13 ++++++++++++-
 doc/upgrade.html      | 13 +++++++------
 4 files changed, 42 insertions(+), 9 deletions(-)

(limited to 'doc')

diff --git a/doc/s6-svlisten.html b/doc/s6-svlisten.html
index 0a3f427..192b351 100644
--- a/doc/s6-svlisten.html
+++ b/doc/s6-svlisten.html
@@ -51,7 +51,18 @@ directories</a> given as arguments in the first block and monitor
 their state changes. </li>
  <li> It spawns <em>prog...</em> as a child right after getting the
 initial state of all the monitored services. </li>
- <li> It then blocks until the wanted state happens, then exits 0. </li>
+ <li> It then blocks until the wanted state happens. </li>
+</ul>
+
+<h2> Exit codes </h2>
+
+<ul>
+ <li> 0: success, the wanted state has been reached </li>
+ <li> 99: timed out </li>
+ <li> 100: wrong usage </li>
+ <li> 111: system call failed </li>
+ <li> <em>n</em>: services were expected to come up, but <em>n</em> of them
+reported permanent failure </li>
 </ul>
 
 <h2> Options </h2>
diff --git a/doc/s6-svlisten1.html b/doc/s6-svlisten1.html
index 762c3ff..902e0be 100644
--- a/doc/s6-svlisten1.html
+++ b/doc/s6-svlisten1.html
@@ -39,7 +39,17 @@ supervised service, and blocks until said service goes up, or down.
 state changes. </li>
  <li> It spawns <em>prog...</em> as a child right after getting the
 initial state of the service. </li>
- <li> It then blocks until the wanted state happens, then exits 0. </li>
+ <li> It then blocks until the wanted state happens. </li>
+</ul>
+
+<h2> Exit codes </h2>
+
+<ul>
+ <li> 0: success, the wanted state has been reached </li>
+ <li> 1: the service was supposed to go up, but reported permanent failure </li>
+ <li> 99: timed out </li>
+ <li> 100: wrong usage </li>
+ <li> 111: system call failed </li>
 </ul>
 
 <h2> Options </h2>
diff --git a/doc/s6-svwait.html b/doc/s6-svwait.html
index 681dd8f..36b1835 100644
--- a/doc/s6-svwait.html
+++ b/doc/s6-svwait.html
@@ -35,9 +35,20 @@ s6-svwait only waits for notifications; it never polls.
 <p>
 s6-svwait monitors one or more <a href="servicedir.html">service
 directories</a> given as its arguments, waiting for a state (ready, up or down) to
-happen. It exits 0 when the wanted condition becomes true.
+happen.
 </p>
 
+<h2> Exit codes </h2>
+
+<ul>
+ <li> 0: success, the wanted state has been reached </li>
+ <li> 99: timed out </li>
+ <li> 100: wrong usage </li>
+ <li> 111: system call failed </li>
+ <li> <em>n</em>: services were expected to come up, but <em>n</em> of them
+reported permanent failure </li>
+</ul>
+
 <h2> Options </h2>
 
 <ul>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 3a4c104..b6ed251 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -23,12 +23,13 @@
 <ul>
  <li> skalibs dependency bumped to 2.5.0.0. </li>
  <li> execline dependency bumped to 2.3.0.0. </li>
-</ul>
-
-<h2> in 2.4.1.0 </h2>
-
-<ul>
- <li> skalibs dependency bumped to 2.4.0.1. </li>
+ <li> Services can now report permanent failure by having <tt>./finish</tt>
+exit 125. </li>
+ <li> <a href="s6-svwait.html">s6-svwait</a>,
+      <a href="s6-svlisten.html">s6-svlisten</a> and
+      <a href="s6-svlisten1.html">s6-svlisten1</a> now exit 99
+when they time out. They exit <em>n</em> when there are <em>n</em>
+services reporting permanent failure. </li>
 </ul>
 
 <h2> in 2.4.0.0 </h2>
-- 
cgit v1.3.1