From 0a39023fd7229371dd3e505208a1c0e073414ac2 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Mon, 15 Jun 2015 18:27:25 +0000
Subject:  - Readiness notification support in s6-supervise  - s6-notifywhenup
 deprecated  - Change abundantly documented  - rc for 2.1.4.0

---
 doc/s6-notifywhenup.html | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

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

diff --git a/doc/s6-notifywhenup.html b/doc/s6-notifywhenup.html
index cdd487c..cdfa693 100644
--- a/doc/s6-notifywhenup.html
+++ b/doc/s6-notifywhenup.html
@@ -18,6 +18,27 @@
 
 <h1> The s6-notifywhenup program </h1>
 
+<em>
+<p>
+Starting with s6-2.1.4.0, the s6-notifywhenup program has been deprecated,
+because there was still a case (albeit extremely rare) where a race
+condition would occur and readiness would be improperly advertised.
+Readiness notification for a service can now be achieved via a
+<tt>notification-fd</tt> file in the
+<a href="servicedir.html">service directory</a>, containing the
+number of the descriptor the service will write its readiness
+notification newline to. The notification will directly be picked by
+<a href="s6-supervise.html">s6-supervise</a>. <br />
+</p>
+
+<p>
+ Quick upgrade recipe: for every service using s6-notifywhenup,
+replace the s6-notifywhenup invocation in your run script with
+<tt>fdmove 1 3</tt>, then perform <tt>echo 3 &gt; notification-fd</tt>.
+Done!
+</p>
+</em>
+
 <p>
 s6-notifywhenup launches a daemon while listening to a file descriptor,
 and sends a 'U' event to a <a href="fifodir.html">fifodir</a> when it
-- 
cgit v1.2.3