Browse Source

Add note about faults and automethod for stopAllProcesses. Related to #198

Mike Naberezny 12 years ago
parent
commit
0a0c575c44
1 changed files with 8 additions and 0 deletions
  1. 8 0
      docs/api.rst

+ 8 - 0
docs/api.rst

@@ -44,6 +44,12 @@ You can extend :program:`supervisord` functionality with new XML-RPC
 API methods by adding new top-level RPC interfaces as necessary.
 See :ref:`rpcinterface_factories`.
 
+.. note::
+
+  Any XML-RPC method call may result in a fault response.  This includes errors caused
+  by the client such as bad arguments, and any errors that make :program:`supervisord`
+  unable to fulfill the request.  Many XML-RPC client programs will raise an exception
+  when a fault response is encountered.
 
 .. automodule:: supervisor.rpcinterface
 
@@ -295,6 +301,8 @@ Process Control
 
     .. automethod:: stopProcessGroup
 
+    .. automethod:: stopAllProcesses
+
     .. automethod:: sendProcessStdin
 
     .. automethod:: sendRemoteCommEvent