[Zope-CVS] SVN: zpkgtools/branches/fdrake-zconfig-branch/ update
documentation references to ZConfig
Fred L. Drake, Jr.
fdrake at gmail.com
Tue Aug 30 10:54:53 EDT 2005
Log message for revision 38157:
update documentation references to ZConfig
Changed:
U zpkgtools/branches/fdrake-zconfig-branch/doc/links.rst
U zpkgtools/branches/fdrake-zconfig-branch/doc/metadata.txt
U zpkgtools/branches/fdrake-zconfig-branch/doc/zpkg.txt
U zpkgtools/branches/fdrake-zconfig-branch/zpkgsetup/package.py
U zpkgtools/branches/fdrake-zconfig-branch/zpkgtools/config.py
-=-
Modified: zpkgtools/branches/fdrake-zconfig-branch/doc/links.rst
===================================================================
--- zpkgtools/branches/fdrake-zconfig-branch/doc/links.rst 2005-08-30 14:41:39 UTC (rev 38156)
+++ zpkgtools/branches/fdrake-zconfig-branch/doc/links.rst 2005-08-30 14:54:53 UTC (rev 38157)
@@ -6,3 +6,5 @@
.. _zpkg: zpkg.html
.. |zpkg| replace:: **zpkg**
+
+.. _ZConfig: http://www.zope.org/Members/fdrake/zconfig/
Modified: zpkgtools/branches/fdrake-zconfig-branch/doc/metadata.txt
===================================================================
--- zpkgtools/branches/fdrake-zconfig-branch/doc/metadata.txt 2005-08-30 14:41:39 UTC (rev 38156)
+++ zpkgtools/branches/fdrake-zconfig-branch/doc/metadata.txt 2005-08-30 14:54:53 UTC (rev 38157)
@@ -162,19 +162,14 @@
scripts
</collection>
-What isn't obvious is that one of the files in the ``ZConfig``
-package under revision control isn't included in either the
-distribution root or the component-specific directory (the
-`BRANCHES.txt` file in particular).
-
Embedded Package Definitions
----------------------------
Distribution components can include a `SETUP.cfg` that contains
information about special files in the component (such as
documentation and scripts), and what extensions need to be built.
-This file is a ZConfig-like configuration file that can contain the
+This file uses the `ZConfig`_ syntax, and contains the
following settings, repeated as necessary:
**documentation**
Modified: zpkgtools/branches/fdrake-zconfig-branch/doc/zpkg.txt
===================================================================
--- zpkgtools/branches/fdrake-zconfig-branch/doc/zpkg.txt 2005-08-30 14:41:39 UTC (rev 38156)
+++ zpkgtools/branches/fdrake-zconfig-branch/doc/zpkg.txt 2005-08-30 14:54:53 UTC (rev 38157)
@@ -108,7 +108,7 @@
Configuration File Format
-------------------------
-The configuration files used by **zpkg** use a subset of the
+The configuration files used by **zpkg** use the
`ZConfig`_ configuration language.
Blank lines and comments (lines that start with ``#`` as the first
@@ -172,9 +172,7 @@
Note that all ``<resources>`` sections will be processed before any
external maps are loaded, regardless of ordering.
-.. _ZConfig: http://www.zope.org/Members/fdrake/zconfig/
-
Resource Maps
-------------
@@ -263,3 +261,5 @@
provided as part of the running **zpkg**; a location only needs to be
specified if a different version should be used. (This seems highly
unlikely.)
+
+.. include:: links.rst
Modified: zpkgtools/branches/fdrake-zconfig-branch/zpkgsetup/package.py
===================================================================
--- zpkgtools/branches/fdrake-zconfig-branch/zpkgsetup/package.py 2005-08-30 14:41:39 UTC (rev 38156)
+++ zpkgtools/branches/fdrake-zconfig-branch/zpkgsetup/package.py 2005-08-30 14:54:53 UTC (rev 38157)
@@ -19,12 +19,6 @@
described for any component, with the exception that extensions only
make sense for package components.
-Package configuration files use a syntax very like the `ZConfig`_
-package, but fewer features are available. The specific syntax is
-implemented by the `zpkgsetup.cfgparser` module.
-
-.. _ZConfig: http://www.zope.org/Members/fdrake/zconfig/
-
There are only a few types of information which can appear in a
package configuration file; the file is intended to describe what a
package provides that is not a module or data file. The three types
Modified: zpkgtools/branches/fdrake-zconfig-branch/zpkgtools/config.py
===================================================================
--- zpkgtools/branches/fdrake-zconfig-branch/zpkgtools/config.py 2005-08-30 14:41:39 UTC (rev 38156)
+++ zpkgtools/branches/fdrake-zconfig-branch/zpkgtools/config.py 2005-08-30 14:54:53 UTC (rev 38157)
@@ -13,14 +13,7 @@
##############################################################################
"""Configuration support for **zpkg**.
-The syntax of the configuration files is incredibly simple, but is
-intended to be a strict subset of the `ZConfig`_. This allows us to
-switch to `ZConfig`_ in the future if we decide the dependency is
-worth it.
-
-.. _ZConfig: http://www.zope.org/Members/fdrake/zconfig/
-
-:undocumented: boolean non_empty_string \*_STRINGS
+:undocumented: non_empty_string resource_map
"""
import os
More information about the Zope-CVS
mailing list