From a44a71d3b95c42604f15316c2fd5d2d78d4dae9b Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Tue, 24 Mar 2015 12:13:53 +0000
Subject:  - Added overview.html  - Added clarifications on s6-svwait

---
 doc/s6-svwait.html | 12 ++++++++++++
 1 file changed, 12 insertions(+)

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

diff --git a/doc/s6-svwait.html b/doc/s6-svwait.html
index 11e9821..2940818 100644
--- a/doc/s6-svwait.html
+++ b/doc/s6-svwait.html
@@ -61,6 +61,18 @@ to stderr and exit 1. By default, <em>timeout</em> is 0, which means no time
 limit. </li>
 </ul>
 
+<h2> Notes <h2>
+
+<ul>
+ <li> s6-svwait should be given one or more <em>service directories</em> as
+arguments, not a <em>scan directory</em>. If you need to wait for a whole
+scan directory, give all its contents as arguments to s6-svwait. </li>
+ <li> s6-svwait will only work on service directories that are already
+active, i.e. have a <a href="s6-supervise.html">s6-supervise</a> process
+running on them. It will not work on a service directory where
+s6-supervise has not been started yet. </li>
+</ul>
+
 <h2> Internals </h2>
 
 <p>
-- 
cgit v1.2.3