[Checkins] SVN: Products.FSDump/trunk/ Fix integration of docs with PyPI long-description; move changelog to docs.

Tres Seaver tseaver at palladion.com
Sun Feb 22 12:42:29 EST 2009


Log message for revision 97114:
  Fix integration of docs with PyPI long-description;  move changelog to docs.

Changed:
  D   Products.FSDump/trunk/Products/FSDump/CHANGES.txt
  A   Products.FSDump/trunk/docs/CHANGES.rst
  A   Products.FSDump/trunk/docs/Overview.rst
  U   Products.FSDump/trunk/docs/index.rst
  U   Products.FSDump/trunk/setup.py

-=-
Deleted: Products.FSDump/trunk/Products/FSDump/CHANGES.txt
===================================================================
--- Products.FSDump/trunk/Products/FSDump/CHANGES.txt	2009-02-22 17:27:13 UTC (rev 97113)
+++ Products.FSDump/trunk/Products/FSDump/CHANGES.txt	2009-02-22 17:42:29 UTC (rev 97114)
@@ -1,163 +0,0 @@
-FSDump Change Log
-=================
-
-0.9.4 (2009-02-22)
-------------------
-
-- Repackaged as a Python egg.
-
-- Converted docs to ReStructured text.
-
-0.9.3 (2006-12-20)
-------------------
-
-- Applied patch from Damine Baty, fixing the output of dumping ZSQLMethods
-  to match the format used by CMF's FSZSQLMethods.
-  
-- Applied patch from Alejo Roda, adding a handler for Formulator forms.
-
-- Applied patch from Willi Langenburger, adding a handler for ZWikiPage
-  objects.
-
-0.9.2 (2005-08-09)
--------------------------
-
-- CVS tag:  'FSDump-0_9_2'
-
-- Reverted 'handler_overrides' brownbag
-
-0.9.1 (2005-08-09)
-------------------
-
-- CVS tag:  'FSDump-0_9_1'
-
-- Added argument to Dumper factory to allow caller to supply handler
-  overrides.
-
-- Applied patch from Sam Brauer, addressing the following issues:
-
-  * Proxy roles and security settings weren't being written to
-    the '.metadata' file.
-
-  * The '[Default]' section should be named '[default]'.
-
-  * The property-type extensions confuse CMF's FilesystemDirectoryView
-    (the patch removes the ':string' for string properties;  others
-    are likely still broken).
-  
-0.9 (2005-04-29)
-----------------
-
-- CVS tag:  'FSDump-0_9'
-
-- Merged Andy Fundinger's work, adding handlers for the following
-  CMFFormController meta_types:
-
-  * ControllerPythonScript
-
-  * ControllerValidator
-
-  * ControllerPageTemplates
-
-- Fix missing import of ConflictError (thanks to Willi Langenburger
-  for the patch).
-
-- Applied a patch from Willi Langenburger to permit use of a dumper
-  in the root of the Zope instance.
-
-0.8.1 (2004-12-09)
-------------------
-
-- CVS tag:  'FSDump-0_8_1'
-
-- Repackaged to nest the actual products directory inside a version-
-  qualified wrapper directory;  added an INSTALL.txt in the wrapper.
-
-0.8 (2004-10-13)
-----------------
-
-- CVS tag:  'FSDump-0_8'
-
-- Applied patch from Zope collector #1463 to make dumped SQL methods
-  fit better with CMF's FSSQLMethod representation.
-
-0.7 (2004-05-17)
-----------------
-
-- CVS tag:  'FSDump-0_7'
-
-- Added knob to force use of single '.metadata' file, rather than
-  multiples (CMF 1.4 compatibility).
-
-- Migrated ZMI to use PageTemplates.
-
-- Bug:  when synthesizing a file extension, Dumper didn't include the
-  synthesized extension in the name of the "companion" properties file.
-
-0.6 (2001-08-09)
-----------------
-
-- CVS tag:  'FSDump-0_6'
-
-- Add handlers for:
-
-  - PageTemplate
-
-0.5 (2001-08-03)
-----------------
-
-- CVS tag:  'FSDump-0_5'
-
-- Add handlers for:
-
-  - PythonScript
-
-0.4 (2001-06-18)
-----------------
-
-- CVS tag:  'FSDump-0_4'
-
-- Conform to the "Finished Project Guidelines",
-  http://dev.zope.org/Wikis/DevSite/Proposals/FinishedProductGuidelines
-
-- Added HelpSystem stuff.
-
-- Moved to use declarative security.
-
-0.3 (2001-01-06)
-----------------
-
-- No CVS tag?
-
-- Dump ZClass icon.
-
-- Add handlers for:
-
-  * Wizards
-
-  * Wizard Pages
-
-0.2 (2000-11-19)
-----------------
-
-- CVS tag:  'FSDump-0_2'
-
-- Add handlers for:
-
-  * ZClasses
-
-  * ZClass property sheets
-
-  * TTW Permissions
-
-  * TTW Factories
-
-- Fix unixism in 'Dumper._setFSPath()' -- thanks
-  Craig! (cba at mediaone.net)
-
-FSDump 0.1 (2000-11-16)
------------------------
-
-- CVS tag:  'FSDump-0_1'
-
-- Initial release

Copied: Products.FSDump/trunk/docs/CHANGES.rst (from rev 97105, Products.FSDump/trunk/Products/FSDump/CHANGES.txt)
===================================================================
--- Products.FSDump/trunk/docs/CHANGES.rst	                        (rev 0)
+++ Products.FSDump/trunk/docs/CHANGES.rst	2009-02-22 17:42:29 UTC (rev 97114)
@@ -0,0 +1,192 @@
+FSDump Change Log
+=================
+
+0.9.4 (2009-02-22)
+------------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/0.9.4
+
+- Repackaged as a Python egg.
+
+- Converted docs to ReStructured text.
+
+- Moved from CVS to SVN.
+
+0.9.3 (2006-12-20)
+------------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_9_3
+
+- Applied patch from Damine Baty, fixing the output of dumping ZSQLMethods
+  to match the format used by CMF's FSZSQLMethods.
+  
+- Applied patch from Alejo Roda, adding a handler for Formulator forms.
+
+- Applied patch from Willi Langenburger, adding a handler for ZWikiPage
+  objects.
+
+0.9.2 (2005-08-09)
+-------------------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_9_2
+
+- CVS tag:  ``FSDump-0_9_2``
+
+- Reverted ``handler_overrides`` brownbag
+
+0.9.1 (2005-08-09)
+------------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_9_1
+
+- CVS tag:  ``FSDump-0_9_1``
+
+- Added argument to Dumper factory to allow caller to supply handler
+  overrides.
+
+- Applied patch from Sam Brauer, addressing the following issues:
+
+  * Proxy roles and security settings weren't being written to
+    the ``.metadata`` file.
+
+  * The ``[Default]`` section should be named ``[default]``.
+
+  * The property-type extensions confuse CMF's FilesystemDirectoryView
+    (the patch removes the ``:string`` for string properties;  others
+    are likely still broken).
+  
+0.9 (2005-04-29)
+----------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_9
+
+- CVS tag:  ``FSDump-0_9``
+
+- Merged Andy Fundinger's work, adding handlers for the following
+  CMFFormController meta_types:
+
+  * ControllerPythonScript
+
+  * ControllerValidator
+
+  * ControllerPageTemplates
+
+- Fix missing import of ConflictError (thanks to Willi Langenburger
+  for the patch).
+
+- Applied a patch from Willi Langenburger to permit use of a dumper
+  in the root of the Zope instance.
+
+0.8.1 (2004-12-09)
+------------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_8_1
+
+- CVS tag:  ``FSDump-0_8_1``
+
+- Repackaged to nest the actual products directory inside a version-
+  qualified wrapper directory;  added an INSTALL.txt in the wrapper.
+
+0.8 (2004-10-13)
+----------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_8
+
+- CVS tag:  ``FSDump-0_8``
+
+- Applied patch from Zope collector #1463 to make dumped SQL methods
+  fit better with CMF's FSSQLMethod representation.
+
+0.7 (2004-05-17)
+----------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_7
+
+- CVS tag:  ``FSDump-0_7``
+
+- Added knob to force use of single ``.metadata`` file, rather than
+  multiples (CMF 1.4 compatibility).
+
+- Migrated ZMI to use PageTemplates.
+
+- Bug:  when synthesizing a file extension, Dumper didn't include the
+  synthesized extension in the name of the "companion" properties file.
+
+0.6 (2001-08-09)
+----------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_6
+
+- CVS tag:  ``FSDump-0_6``
+
+- Add handlers for:
+
+  - PageTemplate
+
+0.5 (2001-08-03)
+----------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_5
+
+- CVS tag:  ``FSDump-0_5``
+
+- Add handlers for:
+
+  - PythonScript
+
+0.4 (2001-06-18)
+----------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_4
+
+- CVS tag:  ``FSDump-0_4``
+
+- Conform to the "Finished Project Guidelines",
+  http://dev.zope.org/Wikis/DevSite/Proposals/FinishedProductGuidelines
+
+- Added HelpSystem stuff.
+
+- Moved to use declarative security.
+
+0.3 (2001-01-06)
+----------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_3
+
+- No CVS tag?
+
+- Dump ZClass icon.
+
+- Add handlers for:
+
+  * Wizards
+
+  * Wizard Pages
+
+0.2 (2000-11-19)
+----------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_2
+
+- CVS tag:  ``FSDump-0_2``
+
+- Add handlers for:
+
+  * ZClasses
+
+  * ZClass property sheets
+
+  * TTW Permissions
+
+  * TTW Factories
+
+- Fix unixism in ``Dumper._setFSPath()`` -- thanks Craig! (cba at mediaone.net)
+
+0.1 (2000-11-16)
+----------------
+
+- SVN:  http://svn.zope.org/Products.FSDump/tags/FSDump-0_1
+
+- CVS tag:  ``FSDump-0_1``
+
+- Initial release

Copied: Products.FSDump/trunk/docs/Overview.rst (from rev 97112, Products.FSDump/trunk/docs/index.rst)
===================================================================
--- Products.FSDump/trunk/docs/Overview.rst	                        (rev 0)
+++ Products.FSDump/trunk/docs/Overview.rst	2009-02-22 17:42:29 UTC (rev 97114)
@@ -0,0 +1,61 @@
+FSDump Product Overview
+=======================
+
+FSDump grew out of an itch which many Zope developers have:
+through-the-web development is faster and easier to do, but
+causes significant deployment and configuration management
+problems.  Through-the-web code cannot (easily) be checked into
+CVS, or diffed to show changes, or grepped to find the source
+of an error message.
+
+Goals
+-----
+
+- The first goal is to ease the burden of getting TTW code
+  under version control:  i.e., to make it possible to check
+  a representation of the TTW code into CVS, and then to see
+  what changes between versions.
+
+- Keep the file-system representations of the TTW objects 
+  simple and "natural" (we are explicitly avoiding XML here).
+
+- Future goals might include:
+
+  o Two-way migration (e.g., make changes to dumped items in
+    vim/emacs, and then import those changes back into the
+    TTW code).
+
+Installation
+------------
+
+See the separate `installation directions <INSTALL.html>`_.
+
+
+Usage
+-----
+
+- Use the "Add list" to create a "Dumper" instance in a folder
+  (or Product) which contains the TTW code to be dumped.
+
+- Supply an absolute path to a directory on the filesystem
+  in which the dumper is to create the files (note that the
+  user as whom Zope is running needs write access to this
+  directory).  See the `form help <Dumper_editForm.html>`_.
+
+- Click the "Change and Dump" button to do the dump to the
+  indicated directory.
+
+
+Mapping TTW Code to the Filesystem
+----------------------------------
+
+See the `mappings documentation <Mappings.html>`_.
+
+
+Known Issues
+------------
+
+- Some types of metadata (``bobobase_modification_time``) won't
+  be exported as a property.
+
+- See the `TODO list <TODO.html>`_.

Modified: Products.FSDump/trunk/docs/index.rst
===================================================================
--- Products.FSDump/trunk/docs/index.rst	2009-02-22 17:27:13 UTC (rev 97113)
+++ Products.FSDump/trunk/docs/index.rst	2009-02-22 17:42:29 UTC (rev 97114)
@@ -1,4 +1,3 @@
-
 Products.FSDump Documentation
 =============================
 
@@ -10,69 +9,10 @@
 .. toctree::
    :maxdepth: 2
 
+   Overview
    INSTALL
    Dumper_editForm
    Mappings
+   CHANGES
    TODO
 
-Overview
---------
-
-FSDump grew out of an itch which many Zope developers have:
-through-the-web development is faster and easier to do, but
-causes significant deployment and configuration management
-problems.  Through-the-web code cannot (easily) be checked into
-CVS, or diffed to show changes, or grepped to find the source
-of an error message.
-
-Goals
------
-
-- The first goal is to ease the burden of getting TTW code
-  under version control:  i.e., to make it possible to check
-  a representation of the TTW code into CVS, and then to see
-  what changes between versions.
-
-- Keep the file-system representations of the TTW objects 
-  simple and "natural" (we are explicitly avoiding XML here).
-
-- Future goals might include:
-
-  o Two-way migration (e.g., make changes to dumped items in
-    vim/emacs, and then import those changes back into the
-    TTW code).
-
-Installation
-------------
-
-See the separate `installation directions <INSTALL.html>`_.
-
-
-Usage
------
-
-- Use the "Add list" to create a "Dumper" instance in a folder
-  (or Product) which contains the TTW code to be dumped.
-
-- Supply an absolute path to a directory on the filesystem
-  in which the dumper is to create the files (note that the
-  user as whom Zope is running needs write access to this
-  directory).  See the `form help <Dumper_editForm.html>`_.
-
-- Click the "Change and Dump" button to do the dump to the
-  indicated directory.
-
-
-Mapping TTW Code to the Filesystem
-----------------------------------
-
-See the `mappings documentation <Mappings.html>`_.
-
-
-Known Issues
-------------
-
-- Some types of metadata (``bobobase_modification_time``) won't
-  be exported as a property.
-
-- See the `TODO list <TODO.html>`_.

Modified: Products.FSDump/trunk/setup.py
===================================================================
--- Products.FSDump/trunk/setup.py	2009-02-22 17:27:13 UTC (rev 97113)
+++ Products.FSDump/trunk/setup.py	2009-02-22 17:42:29 UTC (rev 97114)
@@ -16,10 +16,14 @@
     return f.read()
 
 _boundary = '\n' + ('-' * 60) + '\n\n'
-README = (_doc_file('README.txt')
+README = (_doc_file('Overview.rst')
          + _boundary
-         + _doc_file('CHANGES.txt')
+         + _doc_file('Dumper_editForm.rst')
          + _boundary
+         + _doc_file('Mappings.rst')
+         + _boundary
+         + _doc_file('CHANGES.rst')
+         + _boundary
          + "Download\n========"
          )
 



More information about the Checkins mailing list