Bläddra i källkod

Add note that "logfile" is deprecated

Mike Naberezny 11 år sedan
förälder
incheckning
01af2df6bc
1 ändrade filer med 8 tillägg och 6 borttagningar
  1. 8 6
      docs/api.rst

+ 8 - 6
docs/api.rst

@@ -230,7 +230,7 @@ Process Control
              'statename':      'RUNNING',
              'spawnerr':       '',
              'exitstatus':     0,
-             'logfile':        '/path/to/stdout-log',
+             'logfile':        '/path/to/stdout-log', # deprecated, b/c only
              'stdout_logfile': '/path/to/stdout-log',
              'stderr_logfile': '/path/to/stderr-log',
              'pid':            1}
@@ -248,7 +248,7 @@ Process Control
             If process state is running description's value is process_id
             and uptime. Example "pid 18806, uptime 0:03:12 ".
             If process state is stopped description's value is stop time.
-            Example:"Jun 5 03:16 PM ". 
+            Example:"Jun 5 03:16 PM ".
 
         .. describe:: start
 
@@ -272,6 +272,12 @@ Process Control
 
             String description of `state`, see :ref:`process_states`.
 
+        .. describe:: logfile
+
+            Deprecated alias for ``stdout_logfile``.  This is provided only
+            for compatibility with clients written for Supervisor 2.x and
+            may be removed in the future.  Use ``stdout_logfile`` instead.
+
         .. describe:: stdout_logfile
 
             Absolute path and filename to the STDOUT logfile
@@ -290,10 +296,6 @@ Process Control
             Exit status (errorlevel) of process, or 0 if the process is still
             running.
 
-        .. describe:: logfile
-
-            Alias for "stdout_logfile".
-
         .. describe:: pid
 
             UNIX process ID (PID) of the process, or 0 if the process is not