[Zope-Checkins] SVN: Zope/trunk/doc/ Documentation tweaks

Hanno Schlichting hannosch at hannosch.eu
Thu Jun 24 13:58:03 EDT 2010 

Log message for revision 113807:
  Documentation tweaks
  

Changed:
  U   Zope/trunk/doc/DEBUGGING.rst
  U   Zope/trunk/doc/INSTALL-buildout.rst
  U   Zope/trunk/doc/INSTALL.rst
  U   Zope/trunk/doc/SETUID.rst
  U   Zope/trunk/doc/conf.py
  U   Zope/trunk/doc/operation.rst

-=-
Modified: Zope/trunk/doc/DEBUGGING.rst
===================================================================
--- Zope/trunk/doc/DEBUGGING.rst	2010-06-24 17:36:46 UTC (rev 113806)
+++ Zope/trunk/doc/DEBUGGING.rst	2010-06-24 17:58:03 UTC (rev 113807)
@@ -1,30 +1,21 @@
 Running Zope in Debug Mode
 ==========================
 
-If you wish to run Zope in debug mode, set the 'debug-mode'
-configuration file parameter to 'on' (this is the default).  This
-will have the following effects:
+A utility known as 'zopectl' is installed into generated instance homes.
 
-- On UNIX, Zope will not detach from the controlling terminal.
+If you wish to run Zope in debug mode, run zopectl in foreground mode::
 
-- The Z_DEBUG_MODE environment variable gets set, which causes
-  behavioral changes to Zope appropriate for software development.
-  See the configuration file description of 'debug-mode' for more
-  information.
+  $ bin/zopectl fg
 
-Using 'zopectl debug'
----------------------
+You can also use it to inspect a Zope instance's running state via an
+interactive Python interpreter by passing zopectl the 'debug' parameter on the
+command line.
+The 'top-level' Zope object (the root folder) will be bound to the name 'app'
+within the interpreter. You can then use normal Python method calls against app
+and use the Python interpreter normally to inspect results::
 
-A utility known as 'zopectl' is installed into generated instance homes.
-You can use it to inspect a Zope instance's running state via an
-interactive Python interpreter by passing zopectl the 'debug' parameter
-on the command line.  The 'top-level' Zope object (the root folder) will
-be bound to the name 'app' within the interpreter.  You can then use
-normal Python method calls against app and use the Python interpreter
-normally to inspect results::
-
-    [chrism at james Trunk]$ bin/zopectl debug
-    Starting debugger (the name "app" is bound to the top-level Zope object)
-    >>> app.objectIds()
-    ['acl_users', 'Control_Panel', 'temp_folder', 'browser_id_manager', 'session_data_manager', 'error_log', 'index_html', 'standard_error_message']
-    >>> 
+  $ bin/zopectl debug
+  Starting debugger (the name "app" is bound to the top-level Zope object)
+  >>> app.keys()
+  ['acl_users', 'Control_Panel', 'temp_folder', 'browser_id_manager', 'session_data_manager', 'error_log', 'index_html', 'standard_error_message']
+  >>>

Modified: Zope/trunk/doc/INSTALL-buildout.rst
===================================================================
--- Zope/trunk/doc/INSTALL-buildout.rst	2010-06-24 17:36:46 UTC (rev 113806)
+++ Zope/trunk/doc/INSTALL-buildout.rst	2010-06-24 17:58:03 UTC (rev 113807)
@@ -3,7 +3,7 @@
 
 .. highlight:: bash
 
-This document descibes how to get going with Zope using ``zc.buildout``.
+This document describes how to get going with Zope using ``zc.buildout``.
 
 
 About ``zc.buildout``
@@ -18,7 +18,7 @@
 -------------
 
 In order to use Zope, you must have the following pre-requisites
-available: 
+available:
 
 - A supported version of Python, including the development support if
   installed from system-level packages.  Supported versions include:
@@ -80,7 +80,7 @@
   $ bin/mkzopeinstance
 
 You can specify the Python interpreter to use for the instance
-explicitly:: 
+explicitly::
 
   $ bin/mkzopeinstance --python=$PWD/bin/zopepy
 
@@ -103,7 +103,7 @@
 both the Zope software and the configuration and data for your server.
 This procedure involves the following steps:
 
-- Create the home directory for the buildout, including 
+- Create the home directory for the buildout, including
   ``etc``, ``log`` and ``var`` subdirectories.
 
 - Fetch the buildout bootstrap script into the environment.
@@ -116,7 +116,7 @@
  ::
 
    [buildout]
-   parts = instance 
+   parts = instance
    extends = http://download.zope.org/Zope2/index/<Zope version>/versions.cfg
 
    [instance]
@@ -145,7 +145,7 @@
    %define INSTANCE <path to your instance directory>
 
    python $INSTANCE/bin/py[.exe on Windows]
- 
+
    instancehome $INSTANCE
 
 A fully-annotated sample can be found in the Zope2 egg::

Modified: Zope/trunk/doc/INSTALL.rst
===================================================================
--- Zope/trunk/doc/INSTALL.rst	2010-06-24 17:36:46 UTC (rev 113806)
+++ Zope/trunk/doc/INSTALL.rst	2010-06-24 17:58:03 UTC (rev 113807)
@@ -75,4 +75,3 @@
   The traditional "inplace" build is no longer supported.  Always use
   ``mkzopeinstance`` to create instances outside the virtualenv environment.
 
-

Modified: Zope/trunk/doc/SETUID.rst
===================================================================
--- Zope/trunk/doc/SETUID.rst	2010-06-24 17:36:46 UTC (rev 113806)
+++ Zope/trunk/doc/SETUID.rst	2010-06-24 17:58:03 UTC (rev 113807)
@@ -6,7 +6,7 @@
   Apache, Squid or Varnish. In this case, you do not need to run
   or install Zope with root privileges, since the reverse proxy
   will bind to port 80 and proxy back all request to Zope running
-  on an unpriviledged port.
+  on an unprivileged port.
 
 Zope can bind its network service to low ports such as 21 (FTP) and
 80 (HTTP).  In order to bind to low ports, Zope must be started as

Modified: Zope/trunk/doc/conf.py
===================================================================
--- Zope/trunk/doc/conf.py	2010-06-24 17:36:46 UTC (rev 113806)
+++ Zope/trunk/doc/conf.py	2010-06-24 17:58:03 UTC (rev 113807)
@@ -51,7 +51,7 @@
 # The short X.Y version.
 version = '2.13'
 # The full version, including alpha/beta/rc tags.
-release = '2.13.0dev'
+release = '2.13'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

Modified: Zope/trunk/doc/operation.rst
===================================================================
--- Zope/trunk/doc/operation.rst	2010-06-24 17:36:46 UTC (rev 113806)
+++ Zope/trunk/doc/operation.rst	2010-06-24 17:58:03 UTC (rev 113807)
@@ -16,14 +16,14 @@
 Unless you created the file manually, that file should contain fully-
 annotated examples of each directive.
 
-You can also pass an explicit configuration file on the commandline::
+You can also pass an explicit configuration file on the command line::
 
   $ /path/to/zope/instance/bin/zopectl -c /tmp/other.conf show
   ...
   Config file:  /tmp/other.conf
 
 When starting Zope, if you see errors indicating that an address is in
-use, then you may have to change the ports Zope uses for HTTP or FTP. 
+use, then you may have to change the ports Zope uses for HTTP or FTP.
 The default HTTP and FTP ports used by Zope are
 8080 and 8021 respectively. You can change the ports used by
 editing ./etc/zope.conf appropriately.
@@ -36,7 +36,7 @@
     # force-connection-close on
   </http-server>
 
-The address can just be a port number as shown, or a  host:port
+The address can just be a port number as shown, or a host:port
 pair to bind only to a specific interface.
 
 After making any changes to the configuration file, you need to restart any
@@ -52,7 +52,8 @@
   $ /path/to/zope/instance/bin/zopectl fg
 
 In this mode, Zope emits its log messages to the console, and does not
-detach from the terminal.
+detach from the terminal. This also automatically enables debug-mode. Do
+not use this for production servers.
 
 
 Running Zope as a Daemon

More information about the Zope-Checkins mailing list