[Zope-CVS] CVS: Packages/zpkgtools/doc - collections.txt:1.9

[Fred L. Drake, Jr.]

Update of /cvs-repository/Packages/zpkgtools/doc
In directory cvs.zope.org:/tmp/cvs-serv1777

Modified Files:
	collections.txt 
Log Message:
revise the shape of the tree again


=== Packages/zpkgtools/doc/collections.txt 1.8 => 1.9 ===
--- Packages/zpkgtools/doc/collections.txt:1.8	Fri Apr 30 16:00:32 2004
+++ Packages/zpkgtools/doc/collections.txt	Fri Apr 30 16:58:10 2004
@@ -12,23 +12,19 @@
 dependency information.
 
 Collection distributions are laid out as a directory tree with a
-specific form.  If the primary resource being packaged is
-``Collection``, and the release tag is ``collection-1_0``, we get a
-tree that looks like this (assuming it has the ``zope`` package as a
-dependency)::
+specific form.  If the primary resource being packaged is ``ZopeX3``,
+and the release tag is ``ZopeX3-1_0``, we get a tree that looks like
+this (assuming it has the ``zope`` package as a dependency)::
 
-  Collection-1.0/
+  ZopeX3-1.0/
       MANIFEST
       README.txt
-      setup.cfg
+      configure
+      install.py
       setup.py
-      Packages/
-          Collection-collection-1_0/
-              MANIFEST
-              README.txt
-              setup.cfg
-              setup.py
-          zope-collection-1_0/
+
+      Dependencies/
+          zope-ZopeX3-1_0/
               MANIFEST
               setup.cfg
               setup.py
@@ -36,7 +32,9 @@
                   __init__.py
                   README.txt
                   version.txt
+
       Support/
+          Makefile.in
           setuptools/
               __init__.py
               ...
@@ -44,8 +42,18 @@
               __init__.py
               ...
 
+      ZopeX3/
+          bin/
+              mkzeoinstance
+              mkzopeinstance
+              zsync
+          doc/
+              ...
+
 The support packages aren't shown in their entirety, both for brevity
 and because they really aren't the meaningful part of the payload.
+The dependency list is assumed to be shorter than actually expected
+for ZopeX3 as well.
 
 
 Explanation
@@ -57,30 +65,37 @@
 distribution play the distutils game so it's easy to work with.
 Additional directories under the top-level directory contain the
 material being distributed.  The distutils support files there
-(`setup.py`, `setup.cfg`, `MANIFEST`) are all generated by |zpkg|_.
-
-Within the top-level directory, a `Packages/` directory is created
-which contains the packages that define the collection; one of the
-packages it contains includes the files of the collection itself
-(`Collection-collection-1_0/` in this example).  Each component is
-equivalent to a non-collection package of just the one component.
+(`install.py`, `setup.cfg`, `MANIFEST`) are all generated by |zpkg|_.
+(The `install.py` file shown here is simply `setup.py` renamed to
+avoid a casual Python programmer using the distutils model when that's
+not the intention.)
+
+Within the top-level directory, a `Dependencies/` directory is created
+which contains the packages that define the collection.  Each
+component is equivalent to a non-collection package of just the one
+component.
 
 Collections are defined by a set of metadata files similar to
 packages.  These include:
 
-`PUBLICATION.cfg`
-  Publication metadata, including many Dublin Core fields and similar
-  information.  This is required, but is not expected to change often
-  for a distribution.
+`DEPENDENCIES.cfg`
+  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, a comment, or blank.
 
 `PACKAGE.cfg`
   An optional file which describes how the collection distribution
   should be assembled.
 
-`DEPENDENCIES.cfg`
-  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, a comment, or blank.
+`PUBLICATION.cfg`
+  Publication metadata, including many Dublin Core fields and similar
+  information.  This is required, but is not expected to change often
+  for a distribution.
+
+`SETUP.cfg`
+  Information about what's included in the distrubution, primarily for
+  use by a `setup.py` script.  For components that aren't Python
+  packages, this file is required.
 
 Additional information on these files can be found in `Metadata
 Descriptions for Distributions <metadata.html>`_.