From cc32926c5cdda8d9b6e9cb5e00492c05ea902043 Mon Sep 17 00:00:00 2001
From: Hans Huebner <hans.huebner@gmail.com>
Date: Mon, 13 Aug 2012 11:46:54 +0200
Subject: [PATCH] update documentation for STOP

---
 doc/index.xml | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/doc/index.xml b/doc/index.xml
index 6aa0a34..a3fb1a4 100644
--- a/doc/index.xml
+++ b/doc/index.xml
@@ -441,12 +441,17 @@
       </clix:function>
 
       <clix:function generic='true' name='stop'>
-        <clix:lambda-list>acceptor
-        </clix:lambda-list>
+        <clix:lambda-list>acceptor &amp;key soft</clix:lambda-list>
         <clix:returns>acceptor
         </clix:returns>
-        <clix:description>Stops <clix:arg>acceptor</clix:arg> so that it
-        no longer accepts requests.
+        <clix:description>Stops the <clix:arg>acceptor</clix:arg> so
+        that it no longer accepts requests.  If
+        <clix:arg>soft</clix:arg> is true, and there are any requests
+        in progress, wait until all requests are fully processed, but
+        meanwhile do not accept new requests.  Note that
+        <clix:arg>soft</clix:arg> must not be set when calling
+        <clix:ref>stop</clix:ref> from within a request handler, as
+        that will deadlock.
         </clix:description>
       </clix:function>
 
-- 
2.11.4.GIT