[Zope-CVS] CVS: Packages/zpkgtools/doc - TODO.txt:1.5
Fred L. Drake, Jr.
fred at zope.com
Mon Apr 5 11:11:39 EDT 2004
Update of /cvs-repository/Packages/zpkgtools/doc
In directory cvs.zope.org:/tmp/cvs-serv24105
TODO.txt collections.txt metadata.txt
change the names of the metadata files, and update the collections issues
=== Packages/zpkgtools/doc/TODO.txt 1.4 => 1.5 ===
--- Packages/zpkgtools/doc/TODO.txt:1.4 Thu Apr 1 13:36:30 2004
+++ Packages/zpkgtools/doc/TODO.txt Mon Apr 5 11:11:37 2004
@@ -11,7 +11,7 @@
module in Python's standard library as a possible approach to a
-- fix up finddeps.py to stop searching at PUBLICATION.txt boundaries
+- fix up finddeps.py to stop searching at `PUBLICATION.cfg` boundaries
- package assembler script to build sumo/combined distro (in progress)
=== Packages/zpkgtools/doc/collections.txt 1.3 => 1.4 ===
--- Packages/zpkgtools/doc/collections.txt:1.3 Fri Apr 2 18:12:46 2004
+++ Packages/zpkgtools/doc/collections.txt Mon Apr 5 11:11:37 2004
@@ -22,15 +22,15 @@
@@ -58,25 +58,25 @@
Collections are defined by a set of metadata files similar to
packages. These include:
Publication metadata, including many Dublin Core fields and similar
information. This is required, but is not expected to change often
for a distribution.
An optional file which describes what files should be added to the
collection itself from other locations (this is normally expected to
be documentation files or scripts). It is also possible to specify
that files in the collection should not be included in
Another optional file containing a list of direct dependencies, as
well as any files that are specific to the collection. Each line
must be a resource identifier or a comment.
Additional files may be present in a collection; these are copied into
-the collection-specific directory directly unless `INCLUDES.txt`
+the collection-specific directory directly unless `INCLUDES.cfg`
indicates they should not be distributed. The `README.txt` file in
this example is such a file. The files used by distutils will be
generated and added to the directory as well.
@@ -108,11 +108,12 @@
few others). Given this limitation, the collection would need to
have a different name (``ZODB3`` comes to mind).
+ This isn't enough of a problem to worry about at this point; we just
+ need to keep this in mind when naming components.
- We're not currently loading any sort of "package information" for
- collections, but that's what we need to do so we can identify
- scripts and documentation files so we can properly deal with
- installation. It seems odd for a collection to have a
- `package.conf` file for a collection distribution.
+ collections, but this is a software issue, not a design problem.
+ The information file will be called `INSTALL.cfg`.
.. include:: links.rst
=== Packages/zpkgtools/doc/metadata.txt 1.4 => 1.5 ===
--- Packages/zpkgtools/doc/metadata.txt:1.4 Mon Mar 15 18:24:11 2004
+++ Packages/zpkgtools/doc/metadata.txt Mon Apr 5 11:11:37 2004
@@ -8,7 +8,7 @@
Packages will be described using a collection of files that contain
different aspects of the package metadata.
A list of dependencies for this package. This is currently simply a
list of imported packages that aren't provided with the package
(listed one per line), but additional features may be identified by
@@ -22,12 +22,12 @@
leading and trailing whitespace will be ignored. Dependencies are
List of inclusions (and exclusions) that are added/removed from the
package as it's constructed for distribution. This is currently
only used for collection distributions.
General metadata related to a distribution package. This includes
information such as the name of the package (i.e., "Frobnitz
Manager"), author and maintainer information, and Trove
@@ -36,7 +36,7 @@
information distutils normally pushes into the generated `PKG-INFO`
file; this file has the same format as `PKG-INFO`.
This file contains information on building extension modules.
Information about scripts and documentation files will also be
included in this file.
@@ -44,7 +44,7 @@
Embedded Package Definitions
-Packages can include a `package.conf` that contains information about
+Packages can include a `INSTALL.cfg` that contains information about
special files in the package (such as documentation and scripts), and
what extensions need to be built. This file is a ZConfig-like
configuration file that can contain the following settings, repeated
@@ -65,14 +65,14 @@
`.svn` are ignored, as are files named `.cvsignore`.
Paths can only refer to descendents of the directory containing
-`package.conf`, never to that directory itself or anything higher up
+`INSTALL.cfg`, never to that directory itself or anything higher up
the filesystem hierarchy.
Support for Compiled Extensions
Compiled extensions are described using **<extension>** sections in
-the `package.conf` file. The name of the section should be the name
+the `INSTALL.cfg` file. The name of the section should be the name
of the extension module within the package. For example, the
extension ``persistent.cPersistence`` would be represented using a
section of the form::
More information about the Zope-CVS