[Zope-Checkins] SVN: Zope/trunk/doc/ .txt -> .rst
Andreas Jung
andreas at andreas-jung.com
Sat Feb 21 08:53:47 EST 2009
Log message for revision 96916:
.txt -> .rst
Changed:
A Zope/trunk/doc/CHANGES.rst
D Zope/trunk/doc/CHANGES.txt
A Zope/trunk/doc/CREDITS.rst
D Zope/trunk/doc/CREDITS.txt
A Zope/trunk/doc/DEBUGGING.rst
D Zope/trunk/doc/DEBUGGING.txt
A Zope/trunk/doc/INSTALL.rst
D Zope/trunk/doc/INSTALL.txt
A Zope/trunk/doc/SECURITY.rst
D Zope/trunk/doc/SECURITY.txt
A Zope/trunk/doc/SETUID.rst
D Zope/trunk/doc/SETUID.txt
A Zope/trunk/doc/SIGNALS.rst
D Zope/trunk/doc/SIGNALS.txt
A Zope/trunk/doc/WINDOWS.rst
D Zope/trunk/doc/WINDOWS.txt
A Zope/trunk/doc/ZOPE3.rst
D Zope/trunk/doc/ZOPE3.txt
U Zope/trunk/doc/conf.py
A Zope/trunk/doc/index.rst
D Zope/trunk/doc/index.txt
-=-
Copied: Zope/trunk/doc/CHANGES.rst (from rev 96914, Zope/trunk/doc/CHANGES.txt)
===================================================================
--- Zope/trunk/doc/CHANGES.rst (rev 0)
+++ Zope/trunk/doc/CHANGES.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,249 @@
+Changelog
+=========
+
+This file contains change information for the current Zope release.
+Change information for previous versions of Zope can be found in the
+file HISTORY.txt.
+
+Trunk (unreleased)
+------------------
+
+Known issues
+++++++++++++
+
+- Running Zope on Windows is not yet supported in this alpha release.
+ More specifically the generated startup scripts need to be adjusted,
+ while the code itself should work fine.
+
+- ZODB 3.9.0a11 does not work on Windows with Python 2.6 yet.
+
+- There is no old-style full tarball release that resembles the prior
+ releases of Zope at this point.
+
+Restructuring
++++++++++++++
+
+- Removed the specification of `SOFTWARE_HOME` and `ZOPE_HOME` from the
+ standard instance scripts.
+ [hannosch]
+
+- Made the specification of `SOFTWARE_HOME` and `ZOPE_HOME` optional. In
+ addition `INSTANCE_HOME` is no longer required to run the tests of a
+ source checkout of Zope.
+
+- Removed the `test` command from zopectl. The test.py script it was relying
+ on does no longer exist.
+
+- Updated to ZODB 3.9.0a11. ZODB-level version support has been
+ removed and ZopeUndo now is part of Zope2.
+
+- The Zope2 SVN trunk is now a buildout pulling in all dependencies as
+ actual released packages and not SVN externals anymore.
+
+- Make use of the new zope.container and zope.site packages.
+
+- Updated to newer versions of zope packages. Removed long deprecated
+ layer and skin ZCML directives.
+
+- Disabled the XML export on the UI level - the export functionality
+ however is still available on the Python level.
+
+- No longer show the Help! links in the ZMI, if there is no help
+ available. The help system depends on the product registry.
+
+- Updated the quick start page and simplified the standard content.
+ The default index_html is now a page template.
+
+- Removed deprecated Draft and Version support from Products.OFSP.
+ Also removed version handling from the control panel. Versions are
+ no longer supported on the ZODB level.
+
+- Removed left-overs of the deprecated persistent product distribution
+ mechanism.
+
+- The persistent product registry is not required for starting Zope
+ anymore. `enable-product-installation` can be set to off if you don't
+ rely on the functionality provided by the registry.
+
+- ZClasses have been deprecated for two major releases. They have been
+ removed in this version of Zope.
+
+- Avoid deprecation warnings for the md5 and sha modules in Python 2.6
+ by adding conditional imports for the hashlib module.
+
+- Replaced imports from the 'Globals' module throughout the
+ tree with imports from the actual modules; the 'Globals' module
+ was always intended to be an area for shared data, rather than
+ a "facade" for imports. Added zope.deferred.deprecation entries
+ to 'Globals' for all symbols / modules previously imported directly.
+
+- Protect against non-existing zope.conf path and products directories.
+ This makes it possible to run a Zope instance without a Products or
+ lib/python directory.
+
+- Moved exception MountedStorageError from ZODB.POSExceptions
+ to Products.TemporaryFolder.mount (now its only client).
+
+- Moved Zope2-specific module, ZODB/Mount.py, to
+ Products/TemporaryFolder/mount.py (its only client is
+ Products/TemporaryFolder/TemporaryFolder.py).
+
+- Removed spurious import-time dependencies from
+ Products/ZODBMountPoint/MountedObject.py.
+
+- Removed Examples.zexp from the skeleton. The TTW shopping cart isn't
+ any good example of Zope usage anymore.
+
+- Removed deprecated ZTUtil.Iterator module
+
+- Removed deprecated StructuredText module
+
+- Removed deprecated TAL module
+
+- Removed deprecated modules from Products.PageTemplates.
+
+- Removed deprecated ZCML directives from Five including the whole
+ Five.site subpackage.
+
+Features added
+++++++++++++++
+
+- Acquisition has been made aware of __parent__ pointers. This allows
+ direct access to many Zope 3 classes without the need to mixin
+ Acquisition base classes for the security to work.
+
+- MailHost: now uses zope.sendmail for delivering the mail. With this
+ change MailHost integrates with the Zope transaction system (avoids
+ sending dupe emails in case of conflict errors). In addition
+ MailHost now provides support for asynchronous mail delivery. The
+ 'Use queue' configuration option will create a mail queue on the
+ filesystem (under 'Queue directory') and start a queue thread that
+ checks the queue every three seconds. This decouples the sending of
+ mail from its delivery. In addition MailHosts now supports
+ encrypted connections through TLS/SSL.
+
+- SiteErrorLog now includes the entry id in the information copied to
+ the event log. This allowes you to correlate a user error report with
+ the event log after a restart, or let's you find the REQUEST
+ information in the SiteErrorLog when looking at a traceback in the
+ event log.
+
+Bugs Fixed
+++++++++++
+
+- Specified height/width of icons in ZMI listings so the table doesn't
+ jump around while loading.
+
+- After the proper introduction of parent-pointers, it's now
+ wrong to acquisition-wrap content providers. We will now use
+ the "classic" content provider expression from Zope 3.
+
+- Ported c69896 to Five. This fix makes it possible to provide a
+ template using Python, and not have it being set to `None` by
+ the viewlet manager directive.
+
+- Made Five.testbrowser compatible with mechanize 0.1.7b.
+
+- Launchpad #280334: Fixed problem with 'timeout'
+ argument/attribute missing in testbrowser tests.
+
+- Launchpad #267834: proper separation of HTTP header fields
+ using CRLF as requested by RFC 2616.
+
+- Launchpad #257276: fix for possible denial-of-service attack
+ in PythonScript when passing an arbitrary module to the encode()
+ or decode() of strings.
+
+- Launchpad #257269: 'raise SystemExit' with a PythonScript could shutdown
+ a complete Zope instance
+
+- Switch to branch of 'zope.testbrowser' external which suppresses
+ over-the-wire tests.
+
+- Launchpad #143902: Fixed App.ImageFile to use a stream iterator to
+ output the file. Avoid loading the file content when guessing the
+ mimetype and only load the first 1024 bytes of the file when it cannot
+ be guessed from the filename.
+
+- Changed PageTemplateFile not to load the file contents on Zope startup
+ anymore but on first access instead. This brings them inline with the
+ zope.pagetemplate version and speeds up Zope startup.
+
+- Collector #2278: form ':record' objects did not implement enough
+ of the mapping protocol.
+
+- "version.txt" file was being written to the wrong place by the
+ Makefile, causing Zope to report "unreleased version" even for
+ released versions.
+
+- Five.browser.metaconfigure.page didn't protect names from interface
+ superclasses (http://www.zope.org/Collectors/Zope/2333)
+
+- DAV: litmus "notowner_modify" tests warn during a MOVE request
+ because we returned "412 Precondition Failed" instead of "423
+ Locked" when the resource attempting to be moved was itself
+ locked. Fixed by changing Resource.Resource.MOVE to raise the
+ correct error.
+
+- DAV: litmus props tests 19: propvalnspace and 20:
+ propwformed were failing because Zope did not strip off the
+ xmlns: attribute attached to XML property values. We now strip
+ off all attributes that look like xmlns declarations.
+
+- DAV: When a client attempted to unlock a resource with a token
+ that the resource hadn't been locked with, in the past we
+ returned a 204 response. This was incorrect. The "correct"
+ behavior is to do what mod_dav does, which is return a '400
+ Bad Request' error. This was caught by litmus
+ locks.notowner_lock test #10. See
+ http://lists.w3.org/Archives/Public/w3c-dist-auth/2001JanMar/0099.html
+ for further rationale.
+
+- When Zope properties were set via DAV in the "null" namespace
+ (xmlns="") a subsequent PROPFIND for the property would cause the
+ XML representation for that property to show a namespace of
+ xmlns="None". Fixed within OFS.PropertySheets.dav__propstat.
+
+- integrated theuni's additional test from 2.11 (see r73132)
+
+- Relaxed requirements for context of
+ Products.Five.browser.pagetemplatefile.ZopeTwoPageTemplateFile,
+ to reduce barriers for testing renderability of views which
+ use them.
+ (http://www.zope.org/Collectors/Zope/2327)
+
+- PluginIndexes: Fixed 'parseIndexRequest' for false values.
+
+- Collector #2263: 'field2ulines' did not convert empty string
+ correctly.
+
+- Collector #2198: Zope 3.3 fix breaks Five 1.5 test_getNextUtility
+
+- Prevent ZPublisher from insering incorrect <base/> tags into the
+ headers of plain html files served from Zope3 resource directories.
+
+- Changed the condition checking for setting status of
+ HTTPResponse from to account for new-style classes.
+
+- The Wrapper_compare function from tp_compare to tp_richcompare.
+ Also another function Wrapper_richcompare is added.
+
+- The doc test has been slightly changed in ZPublisher to get
+ the error message extracted correctly.
+
+- The changes made in Acquisition.c in Implicit Acquisition
+ comparison made avail to Explicit Acquisition comparison also.
+
+- zopedoctest no longer breaks if the URL contains more than one
+ question mark. It broke even when the second question mark was
+ correctly quoted.
+
+Other Changes
++++++++++++++
+
+- Added lib/python/webdav/litmus-results.txt explaining current
+ test results from the litmus WebDAV torture test.
+
+- DocumentTemplate.DT_Var.newline_to_br(): Simpler, faster
+ implementation.
+
Deleted: Zope/trunk/doc/CHANGES.txt
===================================================================
--- Zope/trunk/doc/CHANGES.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/CHANGES.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,249 +0,0 @@
-Changelog
-=========
-
-This file contains change information for the current Zope release.
-Change information for previous versions of Zope can be found in the
-file HISTORY.txt.
-
-Trunk (unreleased)
-------------------
-
-Known issues
-++++++++++++
-
-- Running Zope on Windows is not yet supported in this alpha release.
- More specifically the generated startup scripts need to be adjusted,
- while the code itself should work fine.
-
-- ZODB 3.9.0a11 does not work on Windows with Python 2.6 yet.
-
-- There is no old-style full tarball release that resembles the prior
- releases of Zope at this point.
-
-Restructuring
-+++++++++++++
-
-- Removed the specification of `SOFTWARE_HOME` and `ZOPE_HOME` from the
- standard instance scripts.
- [hannosch]
-
-- Made the specification of `SOFTWARE_HOME` and `ZOPE_HOME` optional. In
- addition `INSTANCE_HOME` is no longer required to run the tests of a
- source checkout of Zope.
-
-- Removed the `test` command from zopectl. The test.py script it was relying
- on does no longer exist.
-
-- Updated to ZODB 3.9.0a11. ZODB-level version support has been
- removed and ZopeUndo now is part of Zope2.
-
-- The Zope2 SVN trunk is now a buildout pulling in all dependencies as
- actual released packages and not SVN externals anymore.
-
-- Make use of the new zope.container and zope.site packages.
-
-- Updated to newer versions of zope packages. Removed long deprecated
- layer and skin ZCML directives.
-
-- Disabled the XML export on the UI level - the export functionality
- however is still available on the Python level.
-
-- No longer show the Help! links in the ZMI, if there is no help
- available. The help system depends on the product registry.
-
-- Updated the quick start page and simplified the standard content.
- The default index_html is now a page template.
-
-- Removed deprecated Draft and Version support from Products.OFSP.
- Also removed version handling from the control panel. Versions are
- no longer supported on the ZODB level.
-
-- Removed left-overs of the deprecated persistent product distribution
- mechanism.
-
-- The persistent product registry is not required for starting Zope
- anymore. `enable-product-installation` can be set to off if you don't
- rely on the functionality provided by the registry.
-
-- ZClasses have been deprecated for two major releases. They have been
- removed in this version of Zope.
-
-- Avoid deprecation warnings for the md5 and sha modules in Python 2.6
- by adding conditional imports for the hashlib module.
-
-- Replaced imports from the 'Globals' module throughout the
- tree with imports from the actual modules; the 'Globals' module
- was always intended to be an area for shared data, rather than
- a "facade" for imports. Added zope.deferred.deprecation entries
- to 'Globals' for all symbols / modules previously imported directly.
-
-- Protect against non-existing zope.conf path and products directories.
- This makes it possible to run a Zope instance without a Products or
- lib/python directory.
-
-- Moved exception MountedStorageError from ZODB.POSExceptions
- to Products.TemporaryFolder.mount (now its only client).
-
-- Moved Zope2-specific module, ZODB/Mount.py, to
- Products/TemporaryFolder/mount.py (its only client is
- Products/TemporaryFolder/TemporaryFolder.py).
-
-- Removed spurious import-time dependencies from
- Products/ZODBMountPoint/MountedObject.py.
-
-- Removed Examples.zexp from the skeleton. The TTW shopping cart isn't
- any good example of Zope usage anymore.
-
-- Removed deprecated ZTUtil.Iterator module
-
-- Removed deprecated StructuredText module
-
-- Removed deprecated TAL module
-
-- Removed deprecated modules from Products.PageTemplates.
-
-- Removed deprecated ZCML directives from Five including the whole
- Five.site subpackage.
-
-Features added
-++++++++++++++
-
-- Acquisition has been made aware of __parent__ pointers. This allows
- direct access to many Zope 3 classes without the need to mixin
- Acquisition base classes for the security to work.
-
-- MailHost: now uses zope.sendmail for delivering the mail. With this
- change MailHost integrates with the Zope transaction system (avoids
- sending dupe emails in case of conflict errors). In addition
- MailHost now provides support for asynchronous mail delivery. The
- 'Use queue' configuration option will create a mail queue on the
- filesystem (under 'Queue directory') and start a queue thread that
- checks the queue every three seconds. This decouples the sending of
- mail from its delivery. In addition MailHosts now supports
- encrypted connections through TLS/SSL.
-
-- SiteErrorLog now includes the entry id in the information copied to
- the event log. This allowes you to correlate a user error report with
- the event log after a restart, or let's you find the REQUEST
- information in the SiteErrorLog when looking at a traceback in the
- event log.
-
-Bugs Fixed
-++++++++++
-
-- Specified height/width of icons in ZMI listings so the table doesn't
- jump around while loading.
-
-- After the proper introduction of parent-pointers, it's now
- wrong to acquisition-wrap content providers. We will now use
- the "classic" content provider expression from Zope 3.
-
-- Ported c69896 to Five. This fix makes it possible to provide a
- template using Python, and not have it being set to `None` by
- the viewlet manager directive.
-
-- Made Five.testbrowser compatible with mechanize 0.1.7b.
-
-- Launchpad #280334: Fixed problem with 'timeout'
- argument/attribute missing in testbrowser tests.
-
-- Launchpad #267834: proper separation of HTTP header fields
- using CRLF as requested by RFC 2616.
-
-- Launchpad #257276: fix for possible denial-of-service attack
- in PythonScript when passing an arbitrary module to the encode()
- or decode() of strings.
-
-- Launchpad #257269: 'raise SystemExit' with a PythonScript could shutdown
- a complete Zope instance
-
-- Switch to branch of 'zope.testbrowser' external which suppresses
- over-the-wire tests.
-
-- Launchpad #143902: Fixed App.ImageFile to use a stream iterator to
- output the file. Avoid loading the file content when guessing the
- mimetype and only load the first 1024 bytes of the file when it cannot
- be guessed from the filename.
-
-- Changed PageTemplateFile not to load the file contents on Zope startup
- anymore but on first access instead. This brings them inline with the
- zope.pagetemplate version and speeds up Zope startup.
-
-- Collector #2278: form ':record' objects did not implement enough
- of the mapping protocol.
-
-- "version.txt" file was being written to the wrong place by the
- Makefile, causing Zope to report "unreleased version" even for
- released versions.
-
-- Five.browser.metaconfigure.page didn't protect names from interface
- superclasses (http://www.zope.org/Collectors/Zope/2333)
-
-- DAV: litmus "notowner_modify" tests warn during a MOVE request
- because we returned "412 Precondition Failed" instead of "423
- Locked" when the resource attempting to be moved was itself
- locked. Fixed by changing Resource.Resource.MOVE to raise the
- correct error.
-
-- DAV: litmus props tests 19: propvalnspace and 20:
- propwformed were failing because Zope did not strip off the
- xmlns: attribute attached to XML property values. We now strip
- off all attributes that look like xmlns declarations.
-
-- DAV: When a client attempted to unlock a resource with a token
- that the resource hadn't been locked with, in the past we
- returned a 204 response. This was incorrect. The "correct"
- behavior is to do what mod_dav does, which is return a '400
- Bad Request' error. This was caught by litmus
- locks.notowner_lock test #10. See
- http://lists.w3.org/Archives/Public/w3c-dist-auth/2001JanMar/0099.html
- for further rationale.
-
-- When Zope properties were set via DAV in the "null" namespace
- (xmlns="") a subsequent PROPFIND for the property would cause the
- XML representation for that property to show a namespace of
- xmlns="None". Fixed within OFS.PropertySheets.dav__propstat.
-
-- integrated theuni's additional test from 2.11 (see r73132)
-
-- Relaxed requirements for context of
- Products.Five.browser.pagetemplatefile.ZopeTwoPageTemplateFile,
- to reduce barriers for testing renderability of views which
- use them.
- (http://www.zope.org/Collectors/Zope/2327)
-
-- PluginIndexes: Fixed 'parseIndexRequest' for false values.
-
-- Collector #2263: 'field2ulines' did not convert empty string
- correctly.
-
-- Collector #2198: Zope 3.3 fix breaks Five 1.5 test_getNextUtility
-
-- Prevent ZPublisher from insering incorrect <base/> tags into the
- headers of plain html files served from Zope3 resource directories.
-
-- Changed the condition checking for setting status of
- HTTPResponse from to account for new-style classes.
-
-- The Wrapper_compare function from tp_compare to tp_richcompare.
- Also another function Wrapper_richcompare is added.
-
-- The doc test has been slightly changed in ZPublisher to get
- the error message extracted correctly.
-
-- The changes made in Acquisition.c in Implicit Acquisition
- comparison made avail to Explicit Acquisition comparison also.
-
-- zopedoctest no longer breaks if the URL contains more than one
- question mark. It broke even when the second question mark was
- correctly quoted.
-
-Other Changes
-+++++++++++++
-
-- Added lib/python/webdav/litmus-results.txt explaining current
- test results from the litmus WebDAV torture test.
-
-- DocumentTemplate.DT_Var.newline_to_br(): Simpler, faster
- implementation.
-
Copied: Zope/trunk/doc/CREDITS.rst (from rev 96914, Zope/trunk/doc/CREDITS.txt)
===================================================================
--- Zope/trunk/doc/CREDITS.rst (rev 0)
+++ Zope/trunk/doc/CREDITS.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,64 @@
+Credits
+=======
+
+The Zope software receives contributions from far and wide. Here's
+the Zope Hall of Fame:
+
+- Stephen Purcell allows us to distribute his PyUnit unit testing
+ framework with Zope.
+
+- Jeff Bauer is Zope Dude Number One. Jeff took over PCGI and
+ kept pushing it forward through the years.
+
+- Sam Rushing worked with us at Digital Creations to make Medusa
+ the publishing platform for ZServer and the concurrency of Zope2.
+
+- A subset of windows guru Mark Hammond's win32 extensions are
+ bundled with win32 binary distributions of Zope.
+
+- Martijn Pieters and Brian Hooper contributed the #in reverse
+ attribute.
+
+- Phillip Eby contributed the DTML 'let' tag and many
+ other useful ideas, including the inspiration for the DTML
+ 'call', 'with' and 'return'
+ tags.
+
+- The DateTime module was based on work from Ted Horst.
+
+- Jordan Baker contributed the 'try' tag, something we've wanted
+ for a long, long time.
+
+- Martijn Pieters chipped in with a safe range function.
+
+- Michael Hauser came up with the name "Zope".
+
+- Eric Kidd from Userland contributed to ZPublisher's support for
+ XML-RPC.
+
+- Andrew M. Kuchling wrote the initial version of mod_pcgi, making
+ him extremely cool in our book.
+
+- Oleg Broytmann has taken up the standard of mod_pcgi and moving
+ it to be a really amazing thing, and ready for prime time.
+
+- Jephte CLAIN made some patches to European ZopeTime.
+
+- Thanks to Gregor Hoffleit for his work in getting Zope into the
+ Debian distribution.
+
+- All the other Zopistas far and wide that stuck with us during
+ the Bobo/Principia days and politely push us to make the best damn
+ app server on this or any other planet.
+
+- Of course the list of credits would be quite incomplete without
+ mentioning Guido van Rossum, benevolent dictator of Python and
+ long-time friend of Digital Creations. Zope Power is Python
+ Power.
+
+- Special thanks to Richard Stallman and the Free Software
+ Foundation for their assistance and feedback on the
+ GPL-compatible 2.0 version of the Zope Public License.
+
+
+
Deleted: Zope/trunk/doc/CREDITS.txt
===================================================================
--- Zope/trunk/doc/CREDITS.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/CREDITS.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,64 +0,0 @@
-Credits
-=======
-
-The Zope software receives contributions from far and wide. Here's
-the Zope Hall of Fame:
-
-- Stephen Purcell allows us to distribute his PyUnit unit testing
- framework with Zope.
-
-- Jeff Bauer is Zope Dude Number One. Jeff took over PCGI and
- kept pushing it forward through the years.
-
-- Sam Rushing worked with us at Digital Creations to make Medusa
- the publishing platform for ZServer and the concurrency of Zope2.
-
-- A subset of windows guru Mark Hammond's win32 extensions are
- bundled with win32 binary distributions of Zope.
-
-- Martijn Pieters and Brian Hooper contributed the #in reverse
- attribute.
-
-- Phillip Eby contributed the DTML 'let' tag and many
- other useful ideas, including the inspiration for the DTML
- 'call', 'with' and 'return'
- tags.
-
-- The DateTime module was based on work from Ted Horst.
-
-- Jordan Baker contributed the 'try' tag, something we've wanted
- for a long, long time.
-
-- Martijn Pieters chipped in with a safe range function.
-
-- Michael Hauser came up with the name "Zope".
-
-- Eric Kidd from Userland contributed to ZPublisher's support for
- XML-RPC.
-
-- Andrew M. Kuchling wrote the initial version of mod_pcgi, making
- him extremely cool in our book.
-
-- Oleg Broytmann has taken up the standard of mod_pcgi and moving
- it to be a really amazing thing, and ready for prime time.
-
-- Jephte CLAIN made some patches to European ZopeTime.
-
-- Thanks to Gregor Hoffleit for his work in getting Zope into the
- Debian distribution.
-
-- All the other Zopistas far and wide that stuck with us during
- the Bobo/Principia days and politely push us to make the best damn
- app server on this or any other planet.
-
-- Of course the list of credits would be quite incomplete without
- mentioning Guido van Rossum, benevolent dictator of Python and
- long-time friend of Digital Creations. Zope Power is Python
- Power.
-
-- Special thanks to Richard Stallman and the Free Software
- Foundation for their assistance and feedback on the
- GPL-compatible 2.0 version of the Zope Public License.
-
-
-
Copied: Zope/trunk/doc/DEBUGGING.rst (from rev 96914, Zope/trunk/doc/DEBUGGING.txt)
===================================================================
--- Zope/trunk/doc/DEBUGGING.rst (rev 0)
+++ Zope/trunk/doc/DEBUGGING.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,30 @@
+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:
+
+- On UNIX, Zope will not detach from the controlling terminal.
+
+- 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.
+
+Using 'zopectl debug'
+---------------------
+
+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']
+ >>>
Deleted: Zope/trunk/doc/DEBUGGING.txt
===================================================================
--- Zope/trunk/doc/DEBUGGING.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/DEBUGGING.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,30 +0,0 @@
-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:
-
-- On UNIX, Zope will not detach from the controlling terminal.
-
-- 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.
-
-Using 'zopectl debug'
----------------------
-
-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']
- >>>
Copied: Zope/trunk/doc/INSTALL.rst (from rev 96914, Zope/trunk/doc/INSTALL.txt)
===================================================================
--- Zope/trunk/doc/INSTALL.rst (rev 0)
+++ Zope/trunk/doc/INSTALL.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,197 @@
+========================================
+Building and installing Zope from source
+========================================
+
+Welcome to Zope! This document describes building and installing
+Zope on UNIX and Linux.
+
+See ``doc/WINDOWS.txt`` for information about Windows. See the
+``doc/PLATFORMS`` directory for notes about various other platforms.
+
+
+Prerequisites
+-------------
+
+System requirements when building from source
+
+- A supported version of Python, including the development support if
+ installed from system-level packages. Supported versions include:
+
+ * 2.5.x, (x >= 4)
+
+ * 2.6.x
+
+- Zope needs the Python ``zlib`` module to be importable. If you are
+ building your own Python from source, please be sure that you have the
+ headers installed which correspond to your system's ``zlib``.
+
+- A C compiler capable of building extension modules for your Python
+ (gcc recommended).
+
+
+Building Zope using zc.buildout
+-------------------------------
+
+Zope is built using the ``zc.buildout`` library, which needs to be
+"boostrapped" with your Python version. E.g.::
+
+ $ cd /path/to/zope
+ $ /path/to/your/python bootstrap/bootstrap.py
+
+The boostrap script creates a ``buildout`` script in ``bin``; run this
+script to finish building Zope::
+
+ $ bin/buildout
+
+Installing Zope using easy_install
+----------------------------------
+
+Zope can be installed using ``easy_install`` either using a global
+easy_install installation or within a virtualized Python environment
+(using ``virtualenv``)::
+
+ $ /path/to/easy_install Zope2
+
+This will create the related scripts like ``mkzopeinstance`` within the
+``bin`` folder of you global or virtualized Python environment.
+
+
+Creating a Zope Instance
+------------------------
+
+XXX: Make this not a lie!
+
+Once you've performed the install step, to begin actually using
+Zope, you will need to create an "instance home", which is a
+directory that contains configuration and data for a Zope server
+process. The instance home is created using the ``mkzopeinstance``
+script::
+
+ $ /bin/mkzopeinstance
+
+You will be asked to provide a user name and password for an
+administrator's account during ``mkzopeinstance``. To see the available
+command-line options, run the script with the ``--help`` option::
+
+ $ bin/mkzopeinstance --help
+
+
+Starting Zope as a Daemon
+-------------------------
+
+Once an instance home has been created, the Zope server can now be
+started using this command::
+
+ $ /path/to/zope/instance/bin/zopectl start
+
+During start, zope emits log messages into ./log/event.log
+You can examine it with the usual tools (cat, more, tail)
+and see if there are any errors preventing zope from starting.
+
+
+Running Zope in the Foreground
+------------------------------
+
+By default, ``zopectl start`` will start a background process (a
+"daemon) that manages Zope. ``zopectl stop`` will stop the background
+process. To run Zope without detaching from the console, use the ``fg``
+command (short for ``foreground``)::
+
+ $ /path/to/zope/instance/bin/zopectl fg
+
+In this mode, Zope emits its log messages to the console, and does not
+detach from terminal.
+
+
+Configuring Zope
+----------------
+
+Your Zope instance is configured through a file, either found by
+default::
+
+ $ /path/to/zope/instance/bin/zopectl show
+ ...
+ Config file: /path/to/zope/instance/etc/zope.conf
+
+or passed explicitly on the commandline::
+
+ $ /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 will have to supply arguments to runzope to change the ports
+used 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 apropriately.
+
+The section in the configuration file looks like this::
+
+ <http-server>
+ # valid keys are "address" and "force-connection-close"
+ address 8080
+ # force-connection-close on
+ </http-server>
+
+The address can just be a port number as shown, or a host:port
+pair to bind only to a specific interface.
+
+
+Integrating with System Startup
+-------------------------------
+
+zopectl can be linked as rc-script in the usual start directories
+on linux or other System V unix variants.
+
+You can use ``zopectl`` interactively as a command shell by just
+calling it without any arguments. Try ``help`` there and ``help <command>``
+to find out about additionally commands of zopectl. These commands
+also work at the command line.
+
+
+Logging In To Zope
+------------------
+
+Once you've started Zope, you can then connect to the Zope webserver
+by directing your browser to::
+
+ http://yourhost:8080/manage
+
+where 'yourhost' is the DNS name or IP address of the machine
+running Zope. If you changed the HTTP port as described, use the port
+you configured.
+
+You will be prompted for a user name and password. Use the user name
+and password you provided in response to the prompts issued during
+the "make instance" process.
+
+Now you're off and running! You should be looking at the Zope
+management screen which is divided into two frames. On the left you
+can navigate between Zope objects and on the right you can edit them
+by selecting different management functions with the tabs at the top
+of the frame.
+
+If you haven't used Zope before, you should head to the Zope web
+site and read some documentation. The Zope Documentation section is
+a good place to start. You can access it at:
+
+http://docs.zope.org/
+
+Troubleshooting
+---------------
+
+- This version of Zope requires Python 2.5.4 or better, including
+ 2.6.x. It will *not* run with Python 3.x.
+
+- The Python you run Zope with *must* have threads compiled in,
+ which is the case for a vanilla build. Warning: Zope will not run
+ with a Python version that uses ``libpth``. You *must* use
+ ``libpthread``.
+
+- To build Python extensions you need to have Python configuration
+ information available. If your Python comes from an RPM you may
+ need the python-devel (or python-dev) package installed too. If
+ you built Python from source all the configuration information
+ should already be available.
+
+- See ``doc/CHANGES.txt`` for important notes on this version of Zope.
Deleted: Zope/trunk/doc/INSTALL.txt
===================================================================
--- Zope/trunk/doc/INSTALL.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/INSTALL.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,197 +0,0 @@
-========================================
-Building and installing Zope from source
-========================================
-
-Welcome to Zope! This document describes building and installing
-Zope on UNIX and Linux.
-
-See ``doc/WINDOWS.txt`` for information about Windows. See the
-``doc/PLATFORMS`` directory for notes about various other platforms.
-
-
-Prerequisites
--------------
-
-System requirements when building from source
-
-- A supported version of Python, including the development support if
- installed from system-level packages. Supported versions include:
-
- * 2.5.x, (x >= 4)
-
- * 2.6.x
-
-- Zope needs the Python ``zlib`` module to be importable. If you are
- building your own Python from source, please be sure that you have the
- headers installed which correspond to your system's ``zlib``.
-
-- A C compiler capable of building extension modules for your Python
- (gcc recommended).
-
-
-Building Zope using zc.buildout
--------------------------------
-
-Zope is built using the ``zc.buildout`` library, which needs to be
-"boostrapped" with your Python version. E.g.::
-
- $ cd /path/to/zope
- $ /path/to/your/python bootstrap/bootstrap.py
-
-The boostrap script creates a ``buildout`` script in ``bin``; run this
-script to finish building Zope::
-
- $ bin/buildout
-
-Installing Zope using easy_install
-----------------------------------
-
-Zope can be installed using ``easy_install`` either using a global
-easy_install installation or within a virtualized Python environment
-(using ``virtualenv``)::
-
- $ /path/to/easy_install Zope2
-
-This will create the related scripts like ``mkzopeinstance`` within the
-``bin`` folder of you global or virtualized Python environment.
-
-
-Creating a Zope Instance
-------------------------
-
-XXX: Make this not a lie!
-
-Once you've performed the install step, to begin actually using
-Zope, you will need to create an "instance home", which is a
-directory that contains configuration and data for a Zope server
-process. The instance home is created using the ``mkzopeinstance``
-script::
-
- $ /bin/mkzopeinstance
-
-You will be asked to provide a user name and password for an
-administrator's account during ``mkzopeinstance``. To see the available
-command-line options, run the script with the ``--help`` option::
-
- $ bin/mkzopeinstance --help
-
-
-Starting Zope as a Daemon
--------------------------
-
-Once an instance home has been created, the Zope server can now be
-started using this command::
-
- $ /path/to/zope/instance/bin/zopectl start
-
-During start, zope emits log messages into ./log/event.log
-You can examine it with the usual tools (cat, more, tail)
-and see if there are any errors preventing zope from starting.
-
-
-Running Zope in the Foreground
-------------------------------
-
-By default, ``zopectl start`` will start a background process (a
-"daemon) that manages Zope. ``zopectl stop`` will stop the background
-process. To run Zope without detaching from the console, use the ``fg``
-command (short for ``foreground``)::
-
- $ /path/to/zope/instance/bin/zopectl fg
-
-In this mode, Zope emits its log messages to the console, and does not
-detach from terminal.
-
-
-Configuring Zope
-----------------
-
-Your Zope instance is configured through a file, either found by
-default::
-
- $ /path/to/zope/instance/bin/zopectl show
- ...
- Config file: /path/to/zope/instance/etc/zope.conf
-
-or passed explicitly on the commandline::
-
- $ /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 will have to supply arguments to runzope to change the ports
-used 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 apropriately.
-
-The section in the configuration file looks like this::
-
- <http-server>
- # valid keys are "address" and "force-connection-close"
- address 8080
- # force-connection-close on
- </http-server>
-
-The address can just be a port number as shown, or a host:port
-pair to bind only to a specific interface.
-
-
-Integrating with System Startup
--------------------------------
-
-zopectl can be linked as rc-script in the usual start directories
-on linux or other System V unix variants.
-
-You can use ``zopectl`` interactively as a command shell by just
-calling it without any arguments. Try ``help`` there and ``help <command>``
-to find out about additionally commands of zopectl. These commands
-also work at the command line.
-
-
-Logging In To Zope
-------------------
-
-Once you've started Zope, you can then connect to the Zope webserver
-by directing your browser to::
-
- http://yourhost:8080/manage
-
-where 'yourhost' is the DNS name or IP address of the machine
-running Zope. If you changed the HTTP port as described, use the port
-you configured.
-
-You will be prompted for a user name and password. Use the user name
-and password you provided in response to the prompts issued during
-the "make instance" process.
-
-Now you're off and running! You should be looking at the Zope
-management screen which is divided into two frames. On the left you
-can navigate between Zope objects and on the right you can edit them
-by selecting different management functions with the tabs at the top
-of the frame.
-
-If you haven't used Zope before, you should head to the Zope web
-site and read some documentation. The Zope Documentation section is
-a good place to start. You can access it at:
-
-http://docs.zope.org/
-
-Troubleshooting
----------------
-
-- This version of Zope requires Python 2.5.4 or better, including
- 2.6.x. It will *not* run with Python 3.x.
-
-- The Python you run Zope with *must* have threads compiled in,
- which is the case for a vanilla build. Warning: Zope will not run
- with a Python version that uses ``libpth``. You *must* use
- ``libpthread``.
-
-- To build Python extensions you need to have Python configuration
- information available. If your Python comes from an RPM you may
- need the python-devel (or python-dev) package installed too. If
- you built Python from source all the configuration information
- should already be available.
-
-- See ``doc/CHANGES.txt`` for important notes on this version of Zope.
Copied: Zope/trunk/doc/SECURITY.rst (from rev 96914, Zope/trunk/doc/SECURITY.txt)
===================================================================
--- Zope/trunk/doc/SECURITY.rst (rev 0)
+++ Zope/trunk/doc/SECURITY.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,87 @@
+Setting the initial user name and password
+==========================================
+
+Because Zope is managed through the web, user names and passwords must be
+used to assure that only authorized people can make changes to a Zope
+installation.
+
+Some user name and password is needed to "bootstrap" the creation of
+normal managers of your Zope site. This is accomplished through the
+use of the file 'inituser'. The first time Zope starts, it will detect
+that no users have been defined in the root user folder. It will search
+for the 'inituser' file and, if it exists, will add the user defined
+in the file to the root user folder.
+
+Normally, 'inituser' is created by the Zope install scripts. Either
+the installer prompts for the password or a randomly generated
+password is created and displayed at the end of the build script.
+
+You can use the 'zpasswd.py' script to create 'inituser' yourself.
+Execute 'zpasswd.py' like this::
+
+ python zpasswd.py inituser
+
+The script will prompt you for the name, password, and allowed
+domains. The default is to encode the password with SHA, so please
+remember this password as there is no way to recover it (although
+'zpasswd.py' lets you reset it.)
+
+In some situations you may need to bypass normal security controls
+because you have lost your password or because the security settings
+have been mixed up. Zope provides a facility called an "emergency
+user" so that you can reset passwords and correct security
+settings.
+
+The emergency user password must be defined outside the application
+user interface. It is defined in the 'access' file located
+in the Zope directory. It should be readable only by the user
+as which your web server runs.
+
+To create the emergency user, use 'zpasswd.py' to create the
+'access' file like this::
+
+ python zpasswd.py access
+
+In order to provide a somewhat higher level of security, various
+encoding schemes are supported which provide access to either SHA-1
+encryption or the standard UNIX crypt facility if it has been compiled
+into Python. Unless you have some special requirements (see below),
+you should use the SHA-1 facility, which is the default.
+
+Format of 'inituser' and 'access'
+---------------------------------
+
+A password file should consist of a single line of the form::
+
+ name:password
+
+Note that you may also add an optional third component to the line in the
+access file to restrict access by domain. For example, the line::
+
+ mario:nintendoRules:*.mydomain.com
+
+in your 'access' file will only allow permit emergency user access
+from `*.mydomain.com` machines. Attempts to access the system from
+other domains will fail, even if the correct emergency user name
+and password are used.
+
+Please note that if you use the ZServer monitor capability, you will
+need to run with a clear text password.
+
+Setting permissions on the var directory
+----------------------------------------
+
+You need to set permissions on the Zope var directory.
+Zope needs to read and write data from its var directory. Before
+running Zope you should ensure that you give adequate permissions
+to the Zope var directory for the userid Zope will run under.
+
+Depending on how you choose to run Zope you will need to give
+different permissions to the var directory. If you use Zope with an
+existing web server, it will probably run Zope as 'nobody'. In this
+case 'nobody' needs read and write permissions to the var directory.
+
+If you change the way you run Zope you may need to modify the permissions
+of the var directory and the files in it to allow Zope to read and write
+under its changed userid.
+
Deleted: Zope/trunk/doc/SECURITY.txt
===================================================================
--- Zope/trunk/doc/SECURITY.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/SECURITY.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,87 +0,0 @@
-Setting the initial user name and password
-==========================================
-
-Because Zope is managed through the web, user names and passwords must be
-used to assure that only authorized people can make changes to a Zope
-installation.
-
-Some user name and password is needed to "bootstrap" the creation of
-normal managers of your Zope site. This is accomplished through the
-use of the file 'inituser'. The first time Zope starts, it will detect
-that no users have been defined in the root user folder. It will search
-for the 'inituser' file and, if it exists, will add the user defined
-in the file to the root user folder.
-
-Normally, 'inituser' is created by the Zope install scripts. Either
-the installer prompts for the password or a randomly generated
-password is created and displayed at the end of the build script.
-
-You can use the 'zpasswd.py' script to create 'inituser' yourself.
-Execute 'zpasswd.py' like this::
-
- python zpasswd.py inituser
-
-The script will prompt you for the name, password, and allowed
-domains. The default is to encode the password with SHA, so please
-remember this password as there is no way to recover it (although
-'zpasswd.py' lets you reset it.)
-
-In some situations you may need to bypass normal security controls
-because you have lost your password or because the security settings
-have been mixed up. Zope provides a facility called an "emergency
-user" so that you can reset passwords and correct security
-settings.
-
-The emergency user password must be defined outside the application
-user interface. It is defined in the 'access' file located
-in the Zope directory. It should be readable only by the user
-as which your web server runs.
-
-To create the emergency user, use 'zpasswd.py' to create the
-'access' file like this::
-
- python zpasswd.py access
-
-In order to provide a somewhat higher level of security, various
-encoding schemes are supported which provide access to either SHA-1
-encryption or the standard UNIX crypt facility if it has been compiled
-into Python. Unless you have some special requirements (see below),
-you should use the SHA-1 facility, which is the default.
-
-Format of 'inituser' and 'access'
----------------------------------
-
-A password file should consist of a single line of the form::
-
- name:password
-
-Note that you may also add an optional third component to the line in the
-access file to restrict access by domain. For example, the line::
-
- mario:nintendoRules:*.mydomain.com
-
-in your 'access' file will only allow permit emergency user access
-from `*.mydomain.com` machines. Attempts to access the system from
-other domains will fail, even if the correct emergency user name
-and password are used.
-
-Please note that if you use the ZServer monitor capability, you will
-need to run with a clear text password.
-
-Setting permissions on the var directory
-----------------------------------------
-
-You need to set permissions on the Zope var directory.
-Zope needs to read and write data from its var directory. Before
-running Zope you should ensure that you give adequate permissions
-to the Zope var directory for the userid Zope will run under.
-
-Depending on how you choose to run Zope you will need to give
-different permissions to the var directory. If you use Zope with an
-existing web server, it will probably run Zope as 'nobody'. In this
-case 'nobody' needs read and write permissions to the var directory.
-
-If you change the way you run Zope you may need to modify the permissions
-of the var directory and the files in it to allow Zope to read and write
-under its changed userid.
-
Copied: Zope/trunk/doc/SETUID.rst (from rev 96914, Zope/trunk/doc/SETUID.txt)
===================================================================
--- Zope/trunk/doc/SETUID.rst (rev 0)
+++ Zope/trunk/doc/SETUID.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,30 @@
+Zope effective user support
+===========================
+
+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
+the root user. However, Zope will only run as root long enough to
+bind to these low ports. It will then attempt to setuid to a less
+privileged user.
+
+You must specify the user to which Zope will attempt to setuid by
+changing the 'effective-user' parameter in the zope.conf
+configuration file to an existing username or UID. All runtime
+files will be written as this user. If you do not specify an
+'effective-user' in the configuration file, and you attempt to start
+Zope, it will refuse to start.
+
+Zope additionally emits a warning if you specify 'nobody' as the
+'effective-user'. The rationale for this warning stems from the
+fact that, historically, many other UNIX services dropped privileges
+to the 'nobody' account after starting as root. Any security
+defects in these services could cause someone to gain access as the
+'nobody' account on your system. If someone was to gain control of
+your 'nobody' account they could compromise your Zope files.
+
+The most important thing to remember about effective user support is
+that you don't have to start Zope as root unless you want to listen
+for requests on low ports (ports beneath 1024). In fact, if you
+don't have this need, you are much better off just starting Zope
+under a dedicated user account.
+
Deleted: Zope/trunk/doc/SETUID.txt
===================================================================
--- Zope/trunk/doc/SETUID.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/SETUID.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,30 +0,0 @@
-Zope effective user support
-===========================
-
-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
-the root user. However, Zope will only run as root long enough to
-bind to these low ports. It will then attempt to setuid to a less
-privileged user.
-
-You must specify the user to which Zope will attempt to setuid by
-changing the 'effective-user' parameter in the zope.conf
-configuration file to an existing username or UID. All runtime
-files will be written as this user. If you do not specify an
-'effective-user' in the configuration file, and you attempt to start
-Zope, it will refuse to start.
-
-Zope additionally emits a warning if you specify 'nobody' as the
-'effective-user'. The rationale for this warning stems from the
-fact that, historically, many other UNIX services dropped privileges
-to the 'nobody' account after starting as root. Any security
-defects in these services could cause someone to gain access as the
-'nobody' account on your system. If someone was to gain control of
-your 'nobody' account they could compromise your Zope files.
-
-The most important thing to remember about effective user support is
-that you don't have to start Zope as root unless you want to listen
-for requests on low ports (ports beneath 1024). In fact, if you
-don't have this need, you are much better off just starting Zope
-under a dedicated user account.
-
Copied: Zope/trunk/doc/SIGNALS.rst (from rev 96914, Zope/trunk/doc/SIGNALS.txt)
===================================================================
--- Zope/trunk/doc/SIGNALS.rst (rev 0)
+++ Zope/trunk/doc/SIGNALS.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,27 @@
+Signals (POSIX only)
+====================
+
+Signals are a POSIX inter-process communications mechanism.
+If you are using Windows then this documentation does not apply.
+
+Zope responds to signals which are sent to the process id
+specified in the file '$INSTANCE_HOME/var/Z2.pid'::
+
+ SIGHUP - close open database connections, then restart the server
+ process. A idiom for restarting a Zope server is:
+
+ kill -HUP `cat $INSTANCE_HOME/var/z2.pid`
+
+ SIGTERM - close open database connections then shut down. A common
+ idiom for shutting down Zope is:
+
+ kill -TERM `cat $INSTANCE_HOME/var/Z2.pid`
+
+ SIGINT - same as SIGTERM
+
+ SIGUSR2 - close and re-open all Zope log files (z2.log, event log,
+ detailed log.) A common idiom after rotating Zope log files
+ is:
+
+ kill -USR2 `cat $INSTANCE_HOME/var/z2.pid`
+
Deleted: Zope/trunk/doc/SIGNALS.txt
===================================================================
--- Zope/trunk/doc/SIGNALS.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/SIGNALS.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,27 +0,0 @@
-Signals (POSIX only)
-====================
-
-Signals are a POSIX inter-process communications mechanism.
-If you are using Windows then this documentation does not apply.
-
-Zope responds to signals which are sent to the process id
-specified in the file '$INSTANCE_HOME/var/Z2.pid'::
-
- SIGHUP - close open database connections, then restart the server
- process. A idiom for restarting a Zope server is:
-
- kill -HUP `cat $INSTANCE_HOME/var/z2.pid`
-
- SIGTERM - close open database connections then shut down. A common
- idiom for shutting down Zope is:
-
- kill -TERM `cat $INSTANCE_HOME/var/Z2.pid`
-
- SIGINT - same as SIGTERM
-
- SIGUSR2 - close and re-open all Zope log files (z2.log, event log,
- detailed log.) A common idiom after rotating Zope log files
- is:
-
- kill -USR2 `cat $INSTANCE_HOME/var/z2.pid`
-
Copied: Zope/trunk/doc/WINDOWS.rst (from rev 96914, Zope/trunk/doc/WINDOWS.txt)
===================================================================
--- Zope/trunk/doc/WINDOWS.rst (rev 0)
+++ Zope/trunk/doc/WINDOWS.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,57 @@
+How to build and install Zope from source code on Windows.
+----------------------------------------------------------
+
+* Ensure you have the correct MSVC version installed for the
+ version of Python you will be using.
+
+* Install (or build from sources) Python
+ http://www.python.org
+
+* Install (or build from sources) the Python for Windows extensions
+ http://sourceforge.net/projects/pywin32/
+
+* Unpack the Zope source distribution. Change to that directory.
+
+* Execute:
+ % python.exe inst\configure.py
+ It should say something like:
+ >
+ > - Zope top-level binary directory will be c:\Zope-2.12.
+ > - Makefile written.
+ >
+ > Next, run the Visual C++ batch file "VCVARS32.bat" and then "nmake".
+
+ (run 'configure.py --help' to see how to change things)
+
+* 'makefile' will have ben created. As instructed, execute 'nmake'.
+ If the build succeeds, the last message printed should be:
+ > Zope built. Next, do 'nmake install'.
+
+* As instructed, execute 'nmake install'. A few warnings will be generated,
+ but they can be ignored. The last message in the build process should be:
+ > Zope binaries installed successfully.
+
+* Zope itself has now been installed. We need to create an instance. Run:
+ % python.exe {install_path}\bin\mkzopeinstance.py
+
+ We will be prompted, via the console, for the instance directory and
+ username/password for the admin user.
+
+* We are now ready to start zope. Run:
+ % {zope_instance}\run_zope.bat.
+ Zope should start with nice log messages being printed to
+ stdout. When Zope is ready, you should see:
+ > ------
+ > 2004-10-13T12:27:58 INFO(0) Zope Ready to handle requests
+
+ Press Ctrl+C to stop this instance of the server.
+
+* Optionally, install as a Windows service. Execute:
+ % python {zope_instance}\zope_service.py
+ to see the valid options. You may want something like:
+ % python {zope_instance}\zope_service.py --startup=auto install
+
+ Once installed, it can be started any number of ways:
+ - python {zope_instance}\zope_service.py start
+ - Control Panel
+ - net start service_short_name (eg, `net start Zope_-1227678699`)
Deleted: Zope/trunk/doc/WINDOWS.txt
===================================================================
--- Zope/trunk/doc/WINDOWS.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/WINDOWS.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,57 +0,0 @@
-How to build and install Zope from source code on Windows.
-----------------------------------------------------------
-
-* Ensure you have the correct MSVC version installed for the
- version of Python you will be using.
-
-* Install (or build from sources) Python
- http://www.python.org
-
-* Install (or build from sources) the Python for Windows extensions
- http://sourceforge.net/projects/pywin32/
-
-* Unpack the Zope source distribution. Change to that directory.
-
-* Execute:
- % python.exe inst\configure.py
- It should say something like:
- >
- > - Zope top-level binary directory will be c:\Zope-2.12.
- > - Makefile written.
- >
- > Next, run the Visual C++ batch file "VCVARS32.bat" and then "nmake".
-
- (run 'configure.py --help' to see how to change things)
-
-* 'makefile' will have ben created. As instructed, execute 'nmake'.
- If the build succeeds, the last message printed should be:
- > Zope built. Next, do 'nmake install'.
-
-* As instructed, execute 'nmake install'. A few warnings will be generated,
- but they can be ignored. The last message in the build process should be:
- > Zope binaries installed successfully.
-
-* Zope itself has now been installed. We need to create an instance. Run:
- % python.exe {install_path}\bin\mkzopeinstance.py
-
- We will be prompted, via the console, for the instance directory and
- username/password for the admin user.
-
-* We are now ready to start zope. Run:
- % {zope_instance}\run_zope.bat.
- Zope should start with nice log messages being printed to
- stdout. When Zope is ready, you should see:
- > ------
- > 2004-10-13T12:27:58 INFO(0) Zope Ready to handle requests
-
- Press Ctrl+C to stop this instance of the server.
-
-* Optionally, install as a Windows service. Execute:
- % python {zope_instance}\zope_service.py
- to see the valid options. You may want something like:
- % python {zope_instance}\zope_service.py --startup=auto install
-
- Once installed, it can be started any number of ways:
- - python {zope_instance}\zope_service.py start
- - Control Panel
- - net start service_short_name (eg, `net start Zope_-1227678699`)
Copied: Zope/trunk/doc/ZOPE3.rst (from rev 96914, Zope/trunk/doc/ZOPE3.txt)
===================================================================
--- Zope/trunk/doc/ZOPE3.rst (rev 0)
+++ Zope/trunk/doc/ZOPE3.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,30 @@
+Using Zope Components in Zope 2 Applications
+============================================
+
+Background
+----------
+
+Zope 3 is a separate project from the Zope community aimed at web
+development. It is designed to be more 'programmer-centric' and easier
+to learn, use and extend for programmers. Zope 3 introduces an
+interface-centric component architecture that makes it easier to develop
+and deploy components without requiring developers to learn and
+understand the entire Zope framework.
+
+As of Zope 2.8, the "Five" project has been integrated into the
+Zope 2 core. The "Five" project implements a compatibility layer
+that allows many Zope 3 components and patterns to be used in
+new and existing Zope 2 applications.
+
+Features
+--------
+
+The Five integration layer provides support for Zope 3 interfaces,
+Zope Configuration Markup Language (ZCML), adapters, views,
+utilities and schema-driven content.
+
+Note that the Five layer does *not* attempt to provide a ZMI user
+interface for Zope 3 components.
+
+Zope 2 includes the essential Zope 3 packages, so it is not
+necessary to install Zope 3.
Deleted: Zope/trunk/doc/ZOPE3.txt
===================================================================
--- Zope/trunk/doc/ZOPE3.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/ZOPE3.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,30 +0,0 @@
-Using Zope Components in Zope 2 Applications
-============================================
-
-Background
-----------
-
-Zope 3 is a separate project from the Zope community aimed at web
-development. It is designed to be more 'programmer-centric' and easier
-to learn, use and extend for programmers. Zope 3 introduces an
-interface-centric component architecture that makes it easier to develop
-and deploy components without requiring developers to learn and
-understand the entire Zope framework.
-
-As of Zope 2.8, the "Five" project has been integrated into the
-Zope 2 core. The "Five" project implements a compatibility layer
-that allows many Zope 3 components and patterns to be used in
-new and existing Zope 2 applications.
-
-Features
---------
-
-The Five integration layer provides support for Zope 3 interfaces,
-Zope Configuration Markup Language (ZCML), adapters, views,
-utilities and schema-driven content.
-
-Note that the Five layer does *not* attempt to provide a ZMI user
-interface for Zope 3 components.
-
-Zope 2 includes the essential Zope 3 packages, so it is not
-necessary to install Zope 3.
Modified: Zope/trunk/doc/conf.py
===================================================================
--- Zope/trunk/doc/conf.py 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/conf.py 2009-02-21 13:53:46 UTC (rev 96916)
@@ -32,7 +32,7 @@
templates_path = ['.templates']
# The suffix of source filenames.
-source_suffix = '.txt'
+source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8'
Copied: Zope/trunk/doc/index.rst (from rev 96914, Zope/trunk/doc/index.txt)
===================================================================
--- Zope/trunk/doc/index.rst (rev 0)
+++ Zope/trunk/doc/index.rst 2009-02-21 13:53:46 UTC (rev 96916)
@@ -0,0 +1,28 @@
+.. Zope docs documentation master file, created by sphinx-quickstart on Fri Feb 20 16:22:03 2009.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Zope docs's documentation!
+=====================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ CHANGES.txt
+ INSTALL.txt
+ SECURITY.txt
+ ZOPE3.txt
+ SETUID.txt
+ SIGNALS.txt
+ DEBUGGING.txt
+ CREDITS.txt
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
Deleted: Zope/trunk/doc/index.txt
===================================================================
--- Zope/trunk/doc/index.txt 2009-02-21 13:53:27 UTC (rev 96915)
+++ Zope/trunk/doc/index.txt 2009-02-21 13:53:46 UTC (rev 96916)
@@ -1,28 +0,0 @@
-.. Zope docs documentation master file, created by sphinx-quickstart on Fri Feb 20 16:22:03 2009.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-Welcome to Zope docs's documentation!
-=====================================
-
-Contents:
-
-.. toctree::
- :maxdepth: 2
-
- CHANGES.txt
- INSTALL.txt
- SECURITY.txt
- ZOPE3.txt
- SETUID.txt
- SIGNALS.txt
- DEBUGGING.txt
- CREDITS.txt
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
More information about the Zope-Checkins
mailing list