Chris McDonough 15 лет назад
Родитель
Сommit
e76b98fcc9
9 измененных файлов с 42 добавлено и 24 удалено
  1. 9 8
      docs/configuration.rst
  2. 13 10
      docs/events.rst
  3. 1 1
      docs/faq.rst
  4. 2 2
      docs/installing.rst
  5. 1 1
      docs/introduction.rst
  6. 5 1
      docs/logging.rst
  7. 3 1
      docs/running.rst
  8. 6 0
      docs/subprocess.rst
  9. 2 0
      docs/xmlrpc.rst

+ 9 - 8
docs/configuration.rst

@@ -225,7 +225,7 @@ follows.
   ``debug``, the supervisord log file will record the stderr/stdout
   ``debug``, the supervisord log file will record the stderr/stdout
   output of its child processes and extended info info about process
   output of its child processes and extended info info about process
   state changes, which is useful for debugging a process which isn't
   state changes, which is useful for debugging a process which isn't
-  starting properly.  See also: :ref:`supervisor_log_levels`.
+  starting properly.  See also: :ref:`activity_log_levels`.
 
 
   *Default*:  info
   *Default*:  info
 
 
@@ -490,6 +490,8 @@ follows.
    password = 123
    password = 123
    prompt = mysupervisor
    prompt = mysupervisor
 
 
+.. _programx_section:
+
 ``[program:x]`` Section Settings
 ``[program:x]`` Section Settings
 --------------------------------
 --------------------------------
 
 
@@ -658,9 +660,8 @@ where specified.
 
 
   The number of serial failure attempts that :program:`supervisord`
   The number of serial failure attempts that :program:`supervisord`
   will allow when attempting to start the program before giving up and
   will allow when attempting to start the program before giving up and
-  puting the process into an ``ERROR`` state.  See the process state
-  map elsewhere in this document for explanation of the ``ERROR``
-  state.
+  puting the process into an ``ERROR`` state.  See
+  :ref:`process_states` for explanation of the ``ERROR`` state.
 
 
   *Default*: 3
   *Default*: 3
 
 
@@ -1153,9 +1154,9 @@ above constraints and additions.
 Supervisor allows specialized homogeneous process groups ("event
 Supervisor allows specialized homogeneous process groups ("event
 listener pools") to be defined within the configuration file.  These
 listener pools") to be defined within the configuration file.  These
 pools contain processes that are meant to receive and respond to event
 pools contain processes that are meant to receive and respond to event
-notifications from supervisor's event system.  See
-:ref:`supervisor_events` for an explanation of how events work and how
-to implement programs that can be declared as event listeners.
+notifications from supervisor's event system.  See :ref:`events` for
+an explanation of how events work and how to implement programs that
+can be declared as event listeners.
 
 
 Note that all the options available to ``[program:x]`` sections are
 Note that all the options available to ``[program:x]`` sections are
 respected by eventlistener sections *except* for
 respected by eventlistener sections *except* for
@@ -1180,7 +1181,7 @@ sections do not have.
 
 
   A comma-separated list of event type names that this listener is
   A comma-separated list of event type names that this listener is
   "interested" in receiving notifications for (see
   "interested" in receiving notifications for (see
-  :ref:`supervisor_events` for a list of valid event type names).
+  :ref:`event_types` for a list of valid event type names).
 
 
 ``result_handler``
 ``result_handler``
 
 

+ 13 - 10
docs/events.rst

@@ -1,3 +1,5 @@
+.. _events:
+
 Events
 Events
 ======
 ======
 
 
@@ -179,8 +181,8 @@ pooolserial An integer assigned to each event by the        30
             :program:`supervisord` process will have the
             :program:`supervisord` process will have the
             same ``poolserial`` number.  This value can 
             same ``poolserial`` number.  This value can 
             be used to detect event ordering anomalies.
             be used to detect event ordering anomalies.
-eventname   The specific event type name (see "Supervisor   TICK_5
-            Events" elsewhere in this document)
+eventname   The specific event type name (see               TICK_5
+            :ref:`event_types`)
 len         An integer indicating the number of bytes in    22
 len         An integer indicating the number of bytes in    22
             the event payload, aka the ``PAYLOAD_LENGTH``
             the event payload, aka the ``PAYLOAD_LENGTH``
 =========== =============================================   ===================
 =========== =============================================   ===================
@@ -193,8 +195,8 @@ An example of a complete header line is as follows.
 
 
 Directly following the linefeed character in the header is the event
 Directly following the linefeed character in the header is the event
 payload.  It consists of ``PAYLOAD_LENGTH`` bytes representing a
 payload.  It consists of ``PAYLOAD_LENGTH`` bytes representing a
-serialization of the event data.  See "Supervisor Event Types"
-elsewhere for the specific event data serialization definitions.
+serialization of the event data.  See :ref:`event_types` for the
+specific event data serialization definitions.
 
 
 An example payload for a ``PROCESS_COMMUNICATION_STDOUT`` event
 An example payload for a ``PROCESS_COMMUNICATION_STDOUT`` event
 notification is as follows.
 notification is as follows.
@@ -347,6 +349,8 @@ generate ``PROCESS_COMMUNICATION`` events every so often with memory
 information in them, and an event listener to perform an action based
 information in them, and an event listener to perform an action based
 on processing the data it receives from these events.
 on processing the data it receives from these events.
 
 
+.. _event_types:
+
 Event Types
 Event Types
 -----------
 -----------
 
 
@@ -393,12 +397,11 @@ to receive all event notifications emitted by Supervisor.
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 This process type indicates a process has moved from one state to
 This process type indicates a process has moved from one state to
-another.  See the process state map in "Subprocesses" elsewhere in
-this document for a description of the states that a process moves
-through during its lifetime.  This event type is abstract, it will
-never be sent directly.  Subscribing to this event type will cause a
-subscriber to receive event notifications of all the event types that
-are subtypes of ``PROCESS_STATE``.
+another.  See :ref:`process_states` for a description of the states
+that a process moves through during its lifetime.  This event type is
+abstract, it will never be sent directly.  Subscribing to this event
+type will cause a subscriber to receive event notifications of all the
+event types that are subtypes of ``PROCESS_STATE``.
 
 
 *Name*: ``PROCESS_STATE``
 *Name*: ``PROCESS_STATE``
 
 

+ 1 - 1
docs/faq.rst

@@ -27,7 +27,7 @@ Q
 
 
 A
 A
   This may be due to your process' dependence on environment variable
   This may be due to your process' dependence on environment variable
-  settings.  See "Subprocess Environment" elsewhere in this document.
+  settings.  See :ref:`subprocess_environment`.
 
 
 Q
 Q
   How can I make Supervisor restart a process that's using "too much"
   How can I make Supervisor restart a process that's using "too much"

+ 2 - 2
docs/installing.rst

@@ -105,8 +105,8 @@ For example, ``supervisord -c supervisord.conf``.  Using the ``-c``
 flag actually is redundant in this case, because
 flag actually is redundant in this case, because
 :program:`supervisord` searches the current directory for a
 :program:`supervisord` searches the current directory for a
 :file:`supervisord.conf` before it searches any other locations for
 :file:`supervisord.conf` before it searches any other locations for
-the file, but it will work.  See :ref:`running_chapter` for more
-information about the ``-c`` flag.
+the file, but it will work.  See :ref:`running` for more information
+about the ``-c`` flag.
 
 
 Once you have a configuration file on your filesystem, you can
 Once you have a configuration file on your filesystem, you can
 begin modifying it to your liking.
 begin modifying it to your liking.

+ 1 - 1
docs/introduction.rst

@@ -196,7 +196,7 @@ XML-RPC Interface
           
           
   You can extend :program:`supervisord` functionality with new XML-RPC
   You can extend :program:`supervisord` functionality with new XML-RPC
   API methods by adding new top-level RPC interfaces as necessary.
   API methods by adding new top-level RPC interfaces as necessary.
-  See :ref:`rpcinterface_settings`.
+  See :ref:`rpcinterface_factories`.
 
 
 Platform Requirements
 Platform Requirements
 ---------------------
 ---------------------

+ 5 - 1
docs/logging.rst

@@ -50,6 +50,8 @@ example, if ``loglevel`` is ``error``, messages of ``error`` and
 ``warn``, messages of ``warn``, ``error``, and ``critical`` will be
 ``warn``, messages of ``warn``, ``error``, and ``critical`` will be
 logged.
 logged.
 
 
+.. _activity_log_levels:
+
 Activity Log Levels
 Activity Log Levels
 ~~~~~~~~~~~~~~~~~~~
 ~~~~~~~~~~~~~~~~~~~
 
 
@@ -144,6 +146,8 @@ The configuration keys tht influence child process logging in the
 ``[supervisord]`` config file section are these:
 ``[supervisord]`` config file section are these:
 ``childlogdir``, and ``nocleanup``.
 ``childlogdir``, and ``nocleanup``.
 
 
+.. _capture_mode:
+
 Capture Mode
 Capture Mode
 ~~~~~~~~~~~~
 ~~~~~~~~~~~~
 
 
@@ -156,7 +160,7 @@ non-zero ``stdout_capture_maxbytes`` or ``stderr_capture_maxbytes``
 parameter, each process represented by the program section may emit
 parameter, each process represented by the program section may emit
 special tokens on its stdout or stderr stream (respectively) which
 special tokens on its stdout or stderr stream (respectively) which
 will effectively cause supervisor to emit a ``PROCESS_COMMUNICATION``
 will effectively cause supervisor to emit a ``PROCESS_COMMUNICATION``
-event (see :ref:`supervisor_events` for a description of events).
+event (see :ref:`events` for a description of events).
 
 
 The process communications protocol relies on two tags, one which
 The process communications protocol relies on two tags, one which
 commands supervisor to enter "capture mode" for the stream and one
 commands supervisor to enter "capture mode" for the stream and one

+ 3 - 1
docs/running.rst

@@ -1,3 +1,5 @@
+.. _running:
+
 Running Supervisor
 Running Supervisor
 ==================
 ==================
 
 
@@ -33,7 +35,7 @@ This stanza may be cut and pasted into the :file:`supervisord.conf`
 file.  This is the simplest possible program configuration, because it
 file.  This is the simplest possible program configuration, because it
 only names a command.  Program configuration sections have many other
 only names a command.  Program configuration sections have many other
 configuration options which aren't shown here.  See
 configuration options which aren't shown here.  See
-:ref:`program_configuration` for more information.
+:ref:`programx_section` for more information.
 
 
 Running :program:`supervisord`
 Running :program:`supervisord`
 ------------------------------
 ------------------------------

+ 6 - 0
docs/subprocess.rst

@@ -9,6 +9,8 @@ managed for the entirety of its lifetime by supervisord
 creates).  When a child dies, supervisor is notified of its death via
 creates).  When a child dies, supervisor is notified of its death via
 the ``SIGCHLD`` signal, and it performs the appropriate operation.
 the ``SIGCHLD`` signal, and it performs the appropriate operation.
 
 
+.. _nondaemonizing_of_subprocesses:
+
 Nondaemonizing of Subprocesses
 Nondaemonizing of Subprocesses
 ------------------------------
 ------------------------------
 
 
@@ -126,6 +128,8 @@ entry for a pidproxy-enabled program is provided below.
 The :program:`pidproxy` program is put into your configuration's
 The :program:`pidproxy` program is put into your configuration's
 ``$BINDIR`` when supervisor is installed (it is a "console script").
 ``$BINDIR`` when supervisor is installed (it is a "console script").
 
 
+.. _subprocess_environment:
+
 Subprocess Environment
 Subprocess Environment
 ----------------------
 ----------------------
 
 
@@ -189,6 +193,8 @@ example of setting these enviroment variables is as below.
    user=chrism
    user=chrism
    environment=HOME=/home/chrism,USER=chrism
    environment=HOME=/home/chrism,USER=chrism
 
 
+.. _process_states:
+
 Process States
 Process States
 --------------
 --------------
 
 

+ 2 - 0
docs/xmlrpc.rst

@@ -9,6 +9,8 @@ You needn't understand it unless you wish to use an existing
 third-party RPC interface plugin or if you wish to write your own RPC
 third-party RPC interface plugin or if you wish to write your own RPC
 interface plugin.
 interface plugin.
 
 
+.. _rpcinterface_factories:
+
 Configuring XML-RPC Interface Factories
 Configuring XML-RPC Interface Factories
 ---------------------------------------
 ---------------------------------------