Ver código fonte

Documentation and copyright.

Chris McDonough 19 anos atrás
pai
commit
d6b752bb79
4 arquivos alterados com 99 adições e 19 exclusões
  1. 7 1
      COPYRIGHT.txt
  2. 69 2
      LICENSES.txt
  3. 21 16
      README.txt
  4. 2 0
      TODO.txt

+ 7 - 1
COPYRIGHT.txt

@@ -1,4 +1,10 @@
-Supervisor and meld3 are Copyright (c) 2006, Chris McDonough.
+Supervisor and meld3 are Copyright (c) 2006, Chris McDonough,
+Agendaless Consulting.  http://www.agendaless.com
+
+medusa was (is?) Copyright (c) Sam Rushing.
 
 ElementTree is Copyright (c) 1999-2005 by Secret Labs AB, Copyright
 (c) 1999-2005 by Fredrik Lundh
+
+http_client.py code Copyright (c) by Daniel Krech, http://eikeon.com/.
+

+ 69 - 2
LICENSES.txt

@@ -48,8 +48,38 @@ Supervisor and meld3 are licensed under the Zope Public License (ZPL)
     THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     SUCH DAMAGE.
 
-ElementTree, by Frederik Lundh, which ships with Supervisor as a
-convenience is licensed separately:
+Medusa, the asynchronous communications framework upon which
+supervisor's server and client code is based, was created by Sam
+Rushing:
+
+  Medusa was once distributed under a 'free for non-commercial use'
+  license, but in May of 2000 Sam Rushing changed the license to be
+  identical to the standard Python license at the time.  The standard
+  Python license has always applied to the core components of Medusa,
+  this change just frees up the rest of the system, including the http
+  server, ftp server, utilities, etc.  Medusa is therefore under the
+  following license:
+
+  ============================== 
+  Permission to use, copy, modify, and distribute this software and
+  its documentation for any purpose and without fee is hereby granted,
+  provided that the above copyright notice appear in all copies and
+  that both that copyright notice and this permission notice appear in
+  supporting documentation, and that the name of Sam Rushing not be
+  used in advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  SAM RUSHING DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+  INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
+  NO EVENT SHALL SAM RUSHING BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+  CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+  OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+  NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
+  WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+  ==============================
+
+ElementTree, by Frederik Lundh, which ships with Supervisor is
+licensed as follows:
 
   The ElementTree package and the cElementTree accelerator are:
 
@@ -77,3 +107,40 @@ convenience is licensed separately:
   OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
   TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
   PERFORMANCE OF THIS SOFTWARE.
+
+http_client.py code is based on code by Daniel Krech, which was
+released under this license:
+
+  LICENSE AGREEMENT FOR RDFLIB 0.9.0 THROUGH 2.3.1
+  ------------------------------------------------
+  Copyright (c) 2002-2005, Daniel Krech, http://eikeon.com/
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are
+  met:
+
+    * Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+  copyright notice, this list of conditions and the following
+  disclaimer in the documentation and/or other materials provided
+  with the distribution.
+
+    * Neither the name of Daniel Krech nor the names of its
+  contributors may be used to endorse or promote products derived
+  from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

+ 21 - 16
README.txt

@@ -6,7 +6,7 @@ History
 
 Changes
 
-  2.0: substantial rewrite based on 1.0.6, use ConfigParser rather
+  2.0: fundamental rewrite based on 1.0.6, use ConfigParser rather
   than ZConfig, use HTTP for wire protocol, web interface.
 
 Introduction
@@ -66,8 +66,9 @@ Supported Platforms
 
   Supervisor has been tested and is known to run on Linux (Fedora Core
   5, Ubuntu 6), Mac OS X (10.4), and Solaris (10 for Intel) and
-  FreeBSD 6.1.  It will likely work fine on most UNIX systems.  It
-  will not run at all under any version of Windows.
+  FreeBSD 6.1.  It will likely work fine on most UNIX systems.
+
+  Supervisor will not run at all under any version of Windows.
 
   Supervisor requires Python 2.3 or better.
 
@@ -490,8 +491,8 @@ Signals
   Killing supervisord with SIGHUP will stop all processes, reload the
   configuration from the config file, and restart all processes.
 
-  Killing supervisord with SIGUSR2 will rotate the supervisord and
-  child log files.
+  Killing supervisord with SIGUSR2 will close and reopen the
+  supervisord activity log and child log files.
 
 Access Control
 
@@ -527,15 +528,15 @@ Other Notes
   process/thread which is created by supervisord.  Instead, a
   "special" thread/process is created by these kinds of programs which
   is responsible for handling signals.  This is problematic, because
-  supervisord can only kill a pid which it creates itself.
-  Fortunately, these programs typically write a pidfile which is meant
-  to be read in order to kill the proces.  To service a workaround for
-  this case, a special "pidproxy" program can handle startup of these
-  kinds of processes.  The pidproxy program is a small shim that
-  starts a process, and upon the receipt of a signal, sends the signal
-  to the pid provided in a pidfile.  A sample supervisord
-  configuration program entry for a pidproxy-enabled program is
-  provided here:
+  supervisord can only kill a pid which it creates itself, not any
+  child thread or process of the program it creates.  Fortunately,
+  these programs typically write a pidfile which is meant to be read
+  in order to kill the process.  As a workaround for this case, a
+  special "pidproxy" program can handle startup of these kinds of
+  processes.  The pidproxy program is a small shim that starts a
+  process, and upon the receipt of a signal, sends the signal to the
+  pid provided in a pidfile.  A sample supervisord configuration
+  program entry for a pidproxy-enabled program is provided here:
 
    [program:mysql]
    command=/path/to/pidproxy /path/to/pidfile /path/to/mysqld_safe
@@ -546,8 +547,8 @@ Other Notes
 FAQ
 
   My program never starts and supervisor doesn't indicate any error:
-  Make sure the "x" bit is set on the executable file you're using the
-  command against.
+  Make sure the "x" bit is set on the executable file you're using in
+  the command= line.
 
   How can I tell if my program is running under supervisor? Supervisor
   and its subprocesses share an environment variable
@@ -555,6 +556,10 @@ FAQ
   program can check for the presence of this variable to determine
   whether it is running under supervisor (new in 2.0).
 
+Reporting Bugs
+
+  Please report bugs at http://www.plope.com/software/collector .
+
 Author Information
 
   Chris McDonough (chrism@plope.com)

+ 2 - 0
TODO.txt

@@ -8,6 +8,8 @@
 
 - Expat error on Jens' system running slapd as root after reload.
 
+- Restart of single lone process (cat) doesn't (FF).
+
 - Elementtree dependency.
 
 - Unit tests for log rotation.