[Checkins] SVN: Products.GenericSetup/trunk/ - forward-ported
README/CHANGES ReSTify work from the 1.4 branch
Jens Vagelpohl
jens at dataflake.org
Thu Jun 12 11:29:43 EDT 2008
Log message for revision 87332:
- forward-ported README/CHANGES ReSTify work from the 1.4 branch
Changed:
U Products.GenericSetup/trunk/Products/GenericSetup/CHANGES.txt
U Products.GenericSetup/trunk/Products/GenericSetup/README.txt
U Products.GenericSetup/trunk/setup.py
-=-
Modified: Products.GenericSetup/trunk/Products/GenericSetup/CHANGES.txt
===================================================================
--- Products.GenericSetup/trunk/Products/GenericSetup/CHANGES.txt 2008-06-12 15:27:13 UTC (rev 87331)
+++ Products.GenericSetup/trunk/Products/GenericSetup/CHANGES.txt 2008-06-12 15:29:43 UTC (rev 87332)
@@ -1,284 +1,311 @@
GenericSetup Product Changelog
+==============================
- GenericSetup 1.5.0 (unreleased)
+GenericSetup 1.5.0 (unreleased)
+-------------------------------
- - Made PropertyManagerHelpers class work for non-PropertyManager objects
-
- o Derived classes can supply a '_PROPERTIES' scehma, which is then used
- to mock up a temporary propertysheet for the object. The adapter's
- methods ('_extractProperties', '_purgeProperties', '_initProperties')
- then run against that propertysheet.
+- Made PropertyManagerHelpers class work for non-PropertyManager objects
- - Added logic to respect the destination of upgrade steps when determining
- their applicability.
+ o Derived classes can supply a '_PROPERTIES' scehma, which is then used
+ to mock up a temporary propertysheet for the object. The adapter's
+ methods ('_extractProperties', '_purgeProperties', '_initProperties')
+ then run against that propertysheet.
- - Enhanced the readability of the upgrades tab on the tool.
+- Added logic to respect the destination of upgrade steps when determining
+ their applicability.
- - Changed upgrade logic to set the current version after an upgrade to the
- destination version of the last step run, instead of the current profile
- version.
+- Enhanced the readability of the upgrades tab on the tool.
- - Use the parse_version function from pkg_resources to normalize versions
- before comparing them inside the upgrade code. This ensures pre-release
- versions are handled correctly. Also use the normalize code when sorting
- versions on the tools ZMI upgrades page.
+- Changed upgrade logic to set the current version after an upgrade to the
+ destination version of the last step run, instead of the current profile
+ version.
- - Fixed the upgrade step directive schema. Description is not required.
+- Use the parse_version function from pkg_resources to normalize versions
+ before comparing them inside the upgrade code. This ensures pre-release
+ versions are handled correctly. Also use the normalize code when sorting
+ versions on the tools ZMI upgrades page.
- - Introduced a new IComponentsHandlerBlacklist interface. You can register
- named utilities for it and provide sequences of interfaces which should
- not be handled by the standard components registry adapter. This allows
- more specialized export/import handlers to take full control over the
- components they care about.
+- Fixed the upgrade step directive schema. Description is not required.
- - When loading multiple profiles reload the list of steps to use after
- each import. https://bugs.launchpad.net/zope-cmf/+bug/213905
+- Introduced a new IComponentsHandlerBlacklist interface. You can register
+ named utilities for it and provide sequences of interfaces which should
+ not be handled by the standard components registry adapter. This allows
+ more specialized export/import handlers to take full control over the
+ components they care about.
+- When loading multiple profiles reload the list of steps to use after
+ each import. https://bugs.launchpad.net/zope-cmf/+bug/213905
- GenericSetup 1.4.0 (2008/03/23)
- - Make getProfileImportDate handle situations where one object's id
- is a prefix of another id.
+GenericSetup 1.4.0 (2008-03-23)
+-------------------------------
+- Make getProfileImportDate handle situations where one object's id
+ is a prefix of another id.
- GenericSetup 1.4.0-beta (2008/02/07)
- - During object manager imports do not throw an error when
- trying to remove an object that was already removed.
+GenericSetup 1.4.0-beta (2008-02-07)
+------------------------------------
- - utils: Added MarkerInterfaceHelpers.
+- During object manager imports do not throw an error when
+ trying to remove an object that was already removed.
- - Added default values to the registerProfile ZCML directive.
+- utils: Added MarkerInterfaceHelpers.
- - Add a ZMI interface to find and remove invalid steps from the
- persistent registries.
+- Added default values to the registerProfile ZCML directive.
- - All GenericSetup import and export steps are now registered globally.
+- Add a ZMI interface to find and remove invalid steps from the
+ persistent registries.
- - Remove duplicated test (https://bugs.launchpad.net/zope-cmf/+bug/174910)
+- All GenericSetup import and export steps are now registered globally.
- - Don't create empty 'import_steps.xml' and 'export_steps.xml' files.
+- Remove duplicated test (https://bugs.launchpad.net/zope-cmf/+bug/174910)
- - Fix relative paths for profile dependencies.
+- Don't create empty 'import_steps.xml' and 'export_steps.xml' files.
- - Add support for context dependencies in profiles.
+- Fix relative paths for profile dependencies.
- - Deprecate the version field for import steps.
+- Add support for context dependencies in profiles.
- - Deprecate reading of version.txt to get the version for a profile.
+- Deprecate the version field for import steps.
- - Fire events before and after importing.
+- Deprecate reading of version.txt to get the version for a profile.
- - Use zcml to register import and export steps.
+- Fire events before and after importing.
+- Use zcml to register import and export steps.
- GenericSetup 1.3.3 (unreleased)
- - Be more careful in checking context id validity.
+GenericSetup 1.3.3 (2007-12-29)
+-------------------------------
- - tool: Fixed toolset import handler not to initialize tools again, when
- they already exist in the site.
+- Be more careful in checking context id validity.
+- tool: Fixed toolset import handler not to initialize tools again, when
+ they already exist in the site.
- GenericSetup 1.3.2 (2007/09/11)
- - Ignore import and export step handlers that we can not resolve.
+GenericSetup 1.3.2 (2007-09-11)
+-------------------------------
- - Restore the import context after running steps from a profile
- so we do not break on nested calls.
+- Ignore import and export step handlers that we can not resolve.
- - components: Provide log output when purging utilities or adapters.
+- Restore the import context after running steps from a profile
+ so we do not break on nested calls.
- - components: Fixed an undefined variable name in a log message.
+- components: Provide log output when purging utilities or adapters.
+- components: Fixed an undefined variable name in a log message.
- GenericSetup 1.3.1 (2007/08/08)
- - components: correct the object path for the site root to be the
- empty string.
+GenericSetup 1.3.1 (2007-08-08)
+-------------------------------
- - components: Made output more diff friendly.
+- components: correct the object path for the site root to be the
+ empty string.
- - utils: Added warnings to old code.
- ImportConfiguratorBase and ExportConfiguratorBase will become deprecated
- as soon as GenericSetup itself no longer uses them. HandlerBase is now
- deprecated.
+- components: Made output more diff friendly.
- - components: Added 'components_xmlconfig.html' form.
- This view allows to inspect and edit component registrations. It is also
- available under the ZMI tab 'manage_components'.
+- utils: Added warnings to old code.
+ ImportConfiguratorBase and ExportConfiguratorBase will become deprecated
+ as soon as GenericSetup itself no longer uses them. HandlerBase is now
+ deprecated.
+- components: Added 'components_xmlconfig.html' form.
+ This view allows to inspect and edit component registrations. It is also
+ available under the ZMI tab 'manage_components'.
- GenericSetup 1.3 (2007/07/26)
- - components: Removed non-functional support for registering objects in
- nested folders. We only support objects available in the component
- registry's parent now. The component registry needs to be either
- acquisition wrapped or have a __parent__ pointer to get to the parent.
+GenericSetup 1.3 (2007-07-26)
+-----------------------------
+- components: Removed non-functional support for registering objects in
+ nested folders. We only support objects available in the component
+ registry's parent now. The component registry needs to be either
+ acquisition wrapped or have a __parent__ pointer to get to the parent.
- GenericSetup 1.3-beta (2007/07/12)
- - Guard against situations where encoded text may be compared by the
- differ.
- (http://www.zope.org/Collectors/CMF/471)
+GenericSetup 1.3-beta (2007-07-12)
+----------------------------------
- - Extend the ZCatalog import/export mechanism to allow removal of
- metadata columns in addition to adding them.
- (http://www.zope.org/Collectors/CMF/483)
+- Guard against situations where encoded text may be compared by the
+ differ.
+ (http://www.zope.org/Collectors/CMF/471)
- - Made sure we register Acquisition free objects as utilities in the
- components handler.
+- Extend the ZCatalog import/export mechanism to allow removal of
+ metadata columns in addition to adding them.
+ (http://www.zope.org/Collectors/CMF/483)
- - Profiles now support version numbers; setup tool tracks profile
- versions during upgrades.
+- Made sure we register Acquisition free objects as utilities in the
+ components handler.
- - Added support for nested 'upgradeStep' directives; expanded upgrade
- step registry into a real registry object and not just a dictionary.
+- Profiles now support version numbers; setup tool tracks profile
+ versions during upgrades.
- - Added support for 'metadata.xml' in the profile (read during
- profile registration) to register profile description, version,
- and dependencies.
+- Added support for nested 'upgradeStep' directives; expanded upgrade
+ step registry into a real registry object and not just a dictionary.
- - Deprecated runImportStep and runAllImportSteps in favor of
- runImportStepFromProfile and runAllImportStepsFromProfile.
+- Added support for 'metadata.xml' in the profile (read during
+ profile registration) to register profile description, version,
+ and dependencies.
- - Merged CPS's upgradeStep ZCML directive, w/ corresponding tool support.
+- Deprecated runImportStep and runAllImportSteps in favor of
+ runImportStepFromProfile and runAllImportStepsFromProfile.
- - Added a "last imported" date to the list of extension profiles,
- and to the baseline profile.
+- Merged CPS's upgradeStep ZCML directive, w/ corresponding tool support.
- - Renamed the "Properties" tab to "Profiles".
+- Added a "last imported" date to the list of extension profiles,
+ and to the baseline profile.
- - Removed the 'create_report' decoy in the ZMI view methods: there was
- never any UI for passing any value other than the default, anyway, and
- the report objects are too useful to omit.
+- Renamed the "Properties" tab to "Profiles".
- - Refactored the "Properties" tab to separate baseline profiles from
- extension profiles, marking the option to reset the baseline as
- potentially dangerous for sites which already have one. Allow
- importing one or more extension profiles directly (all steps) from the
- "Properties" tab.
+- Removed the 'create_report' decoy in the ZMI view methods: there was
+ never any UI for passing any value other than the default, anyway, and
+ the report objects are too useful to omit.
- - No longer read the toolset xml and update the toolset regustry on
- import context change. Doing this only during the toolset step import
- should be sufficient.
+- Refactored the "Properties" tab to separate baseline profiles from
+ extension profiles, marking the option to reset the baseline as
+ potentially dangerous for sites which already have one. Allow
+ importing one or more extension profiles directly (all steps) from the
+ "Properties" tab.
- - testing: The test base classes no longer set up any ZCML.
- This change is not backwards compatible. If you are using these base
- classes for testing custom handlers, you have to add the necessary ZCML
- setup and tear down. Using test layers is recommended.
+- No longer read the toolset xml and update the toolset regustry on
+ import context change. Doing this only during the toolset step import
+ should be sufficient.
- - Added support for importing/exporting Zope 3 component registries
- by folding in Hanno Schlichting's GSLocalAddons product.
+- testing: The test base classes no longer set up any ZCML.
+ This change is not backwards compatible. If you are using these base
+ classes for testing custom handlers, you have to add the necessary ZCML
+ setup and tear down. Using test layers is recommended.
+- Added support for importing-exporting Zope 3 component registries
+ by folding in Hanno Schlichting's GSLocalAddons product.
- GenericSetup 1.2-beta (2006/09/20)
- - tool: Added support for uploading a tarball on the "Import" tab
- (i.e., one produced on the export tab).
+GenericSetup 1.2-beta (2006-09-20)
+----------------------------------
- - docs: Added SampleSite demo product.
+- tool: Added support for uploading a tarball on the "Import" tab
+ (i.e., one produced on the export tab).
- - ProfileRegistry: Added 'registerProfile' ZCML directive.
- Using the old registerProfile method in initialize() is now deprecated.
- See doc/profiles.txt for details.
+- docs: Added SampleSite demo product.
- - ProfileRegistry: 'product' should now be the module name.
- For backwards compatibility 'product' is still first looked up in
- Products before searching the default module search path.
+- ProfileRegistry: Added 'registerProfile' ZCML directive.
+ Using the old registerProfile method in initialize() is now deprecated.
+ See doc/profiles.txt for details.
- - ZCTextIndex handler: Fixed 'indexed_attr' import.
- (http://www.zope.org/Collectors/CMF/436)
+- ProfileRegistry: 'product' should now be the module name.
+ For backwards compatibility 'product' is still first looked up in
+ Products before searching the default module search path.
- - docs: Added 'Registering Profiles' section to profiles.txt.
+- ZCTextIndex handler: Fixed 'indexed_attr' import.
+ (http://www.zope.org/Collectors/CMF/436)
- - Added support for PageTemplate import/export, modeled closely after
- existing PythonScript support
+- docs: Added 'Registering Profiles' section to profiles.txt.
- - The dependency sorting was highly reliant on steps being added in the
- right order to work. If import step A depends on import step B which
- depends on step C, and step C gets processed early, and they were
- processed in the order A, C, B, then the dependency order would be
- incorrect. This is now fixed by keeping tack of steps with unresolved
- dependencies, and trying again after inserting everything else.
+- Added support for PageTemplate import/export, modeled closely after
+ existing PythonScript support
- GenericSetup 1.1 (2006/04/16)
+- The dependency sorting was highly reliant on steps being added in the
+ right order to work. If import step A depends on import step B which
+ depends on step C, and step C gets processed early, and they were
+ processed in the order A, C, B, then the dependency order would be
+ incorrect. This is now fixed by keeping tack of steps with unresolved
+ dependencies, and trying again after inserting everything else.
- - ZCatalog handler: Implemented the 'remove' directive for indexes.
- This allows to write extension profiles that remove or replace indexes.
- - getExportStepRegistry had the wrong security declaration
+GenericSetup 1.1 (2006-04-16)
+-----------------------------
- GenericSetup 1.1-beta2 (2006/03/26)
+- ZCatalog handler: Implemented the 'remove' directive for indexes.
+ This allows to write extension profiles that remove or replace indexes.
- No changes - tag created to coincide with CMF 2.0.0-beta2
+- getExportStepRegistry had the wrong security declaration
- GenericSetup 1.1-beta (2006/03/08)
- - Allowed subclasses of DAVAwareFileAdapter to override the filename
- in which the file is stored.
+GenericSetup 1.1-beta2 (2006-03-26)
+-----------------------------------
- - Added a doc directory including some basic documentation.
+- No changes - tag created to coincide with CMF 2.0.0-beta2
- - Made GenericSetup a standalone package independent of the CMF
- - Added 'for_' argument to profile registry operations.
- A profile may be registered and queried as appropriate to a specific
- site interface; the default value, 'None', indicates that the profile
- is relevant to any site. Note that this is essentially an adapter
- lookup; perhaps we should reimplement it so.
+GenericSetup 1.1-beta (2006-03-08)
+----------------------------------
- - Forward ported changes from GenericSetup 0.11 and 0.12 (which were
- created in a separate repository).
+- Allowed subclasses of DAVAwareFileAdapter to override the filename
+ in which the file is stored.
- - A sequence property with the purge="False" attribute will not be
- purged, but merged (the sequences are treated as sets, which means
- that duplicates are removed). This is useful in extension profiles.
+- Added a doc directory including some basic documentation.
- - Don't export or purge read-only properties. Correctly purge
- non-deletable int/float properties.
+- Made GenericSetup a standalone package independent of the CMF
- - Correctly quote XML on export.
+- Added ``for_`` argument to profile registry operations.
+ A profile may be registered and queried as appropriate to a specific
+ site interface; the default value, 'None', indicates that the profile
+ is relevant to any site. Note that this is essentially an adapter
+ lookup; perhaps we should reimplement it so.
- GenericSetup 1.0 (2005/09/23)
+- Forward ported changes from GenericSetup 0.11 and 0.12 (which were
+ created in a separate repository).
- - CVS tag: GenericSetup-1_0
+- A sequence property with the purge="False" attribute will not be
+ purged, but merged (the sequences are treated as sets, which means
+ that duplicates are removed). This is useful in extension profiles.
- - Forward-ported i18n support from CMF 1.5 branch.
+- Don't export or purge read-only properties. Correctly purge
+ non-deletable int/float properties.
- - Forward ported BBB for old instances that stored properties as
- lists from CMFSetup.
+- Correctly quote XML on export.
- - Forward ported fix for tools with non unique IDs from CMFSetup.
- GenericSetup-0.12 (2005/08/29)
+GenericSetup 1.0 (2005-09-23)
+-----------------------------
- - CVS tag: GenericSetup-0_12
+- CVS tag: GenericSetup-1_0
- - Import requests now create reports (by default) which record any
- status messages generated by the profile's steps.
+- Forward-ported i18n support from CMF 1.5 branch.
- GenericSetup-0.11 (2005/08/23)
+- Forward ported BBB for old instances that stored properties as
+ lists from CMFSetup.
- - CVS tag: GenericSetup-0_11
+- Forward ported fix for tools with non unique IDs from CMFSetup.
- - Added report of messages generated by import to the "Import" tab.
- - Consolidated ISetupContext implementation into base class,
- 'SetupContextBase'.
+GenericSetup-0.12 (2005-08-29)
+------------------------------
- - Added 'note', 'listNotes', and 'clearNotes' methods to ISetupContext,
- to allow plugins to record information about the state of the operation.
+- CVS tag: GenericSetup-0_12
- GenericSetup 0.10 (2005/08/11)
+- Import requests now create reports (by default) which record any
+ status messages generated by the profile's steps.
- - CVS tag: GenericSetup-0_10
- - Added TarballImportContext, including full test suite.
+GenericSetup-0.11 (2005-08-23)
+------------------------------
- GenericSetup 0.9 (2005/08/08)
+- CVS tag: GenericSetup-0_11
- - CVS tag: GenericSetup-0_9
+- Added report of messages generated by import to the "Import" tab.
- - Initial version, cut down from CMFSetup-1.5.3
+- Consolidated ISetupContext implementation into base class,
+ 'SetupContextBase'.
+
+- Added 'note', 'listNotes', and 'clearNotes' methods to ISetupContext,
+ to allow plugins to record information about the state of the operation.
+
+
+GenericSetup 0.10 (2005-08-11)
+------------------------------
+
+- CVS tag: GenericSetup-0_10
+
+- Added TarballImportContext, including full test suite.
+
+
+GenericSetup 0.9 (2005-08-08)
+-----------------------------
+
+- CVS tag: GenericSetup-0_9
+
+- Initial version, cut down from CMFSetup-1.5.3
+
Modified: Products.GenericSetup/trunk/Products/GenericSetup/README.txt
===================================================================
--- Products.GenericSetup/trunk/Products/GenericSetup/README.txt 2008-06-12 15:27:13 UTC (rev 87331)
+++ Products.GenericSetup/trunk/Products/GenericSetup/README.txt 2008-06-12 15:29:43 UTC (rev 87332)
@@ -1,55 +1,61 @@
-GenericSetup Product README
+=======================
+ Products.GenericSetup
+=======================
- Overview
+This product provides a mini-framework for expressing the configured
+state of a Zope Site as a set of filesystem artifacts. These artifacts
+consist of declarative XML files, which spell out the configuration
+settings for each "tool" in the site , and supporting scripts / templates,
+in their "canonical" filesystem representations.
- This product provides a mini-framework for expressing the configured
- state of a Zope Site as a set of filesystem artifacts. These artifacts
- consist of declarative XML files, which spell out the configuration
- settings for each "tool" in the site , and supporting scripts / templates,
- in their "canonical" filesystem representations.
+.. contents::
- Configurations Included
+Configurations Included
+=======================
- The 'setup_tool' knows how to export / import configurations and scripts
- for the following tools:
+The 'setup_tool' knows how to export / import configurations and scripts
+for the following tools:
- - (x) removal / creation of specified tools
+- removal / creation of specified tools
- - (x) itself :)
+- itself :)
- - (x) the role / permission map on the "site" object (its parent)
+- the role / permission map on the "site" object (its parent)
- - (x) properties of the site object
+- properties of the site object
- - (x) placeful utilities and adapters registered in the local
- site manager. Placeless utilities can only be imported.
+- placeful utilities and adapters registered in the local
+ site manager. Placeless utilities can only be imported.
- Extending The Tool
+Extending The Tool
+==================
- Third-party products extend the tool by registering handlers for
- import / export of their unique tools.
+Third-party products extend the tool by registering handlers for
+import / export of their unique tools.
- See doc/handlers.txt for a step by step how-to.
+See doc/handlers.txt for a step by step how-to.
- Providing Profiles
+Providing Profiles
+==================
- GenericSetup doesn't ship with any profile. They have to be provided by
- third-party products and depend on the registered handlers.
+GenericSetup doesn't ship with any profile. They have to be provided by
+third-party products and depend on the registered handlers.
- See doc/profiles.txt for more details.
+See doc/profiles.txt for more details.
- Glossary
+Glossary
+========
- Site --
- The instance in the Zope URL space which defines a "zone of service"
- for a set of tools.
+Site --
+ The instance in the Zope URL space which defines a "zone of service"
+ for a set of tools.
- Profile --
- A "preset" configuration of a site, defined on the filesystem
+Profile --
+ A "preset" configuration of a site, defined on the filesystem
- Snapshot --
- "Frozen" site configuration, captured within the setup tool
+Snapshot --
+ "Frozen" site configuration, captured within the setup tool
- "dotted name" --
- The Pythonic representation of the "path" to a given function /
- module, e.g. 'Products.GenericSetup.tool.exportToolset'.
+"dotted name" --
+ The Pythonic representation of the "path" to a given function /
+ module, e.g. 'Products.GenericSetup.tool.exportToolset'.
Modified: Products.GenericSetup/trunk/setup.py
===================================================================
--- Products.GenericSetup/trunk/setup.py 2008-06-12 15:27:13 UTC (rev 87331)
+++ Products.GenericSetup/trunk/setup.py 2008-06-12 15:29:43 UTC (rev 87332)
@@ -18,9 +18,8 @@
VERSION = VERSION[1:]
_boundary = '\n' + ('-' * 60) + '\n'
-README = (open(os.path.join(here, 'README.txt')).read()
- + _boundary + _package_doc('README.txt')
- + _boundary + _package_doc('CHANGES.txt')
+README = ( _package_doc('README.txt')
+ + _boundary + _package_doc('CHANGES.txt')
)
setup(name='Products.GenericSetup',
More information about the Checkins
mailing list