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

[Fred L. Drake, Jr.]

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

Modified Files:
	collections.txt 
Log Message:
- use the external links.rst file
- add more information about what's included in the distribution tree
  for dependencies


=== Packages/zpkgtools/doc/collections.txt 1.1 => 1.2 ===
--- Packages/zpkgtools/doc/collections.txt:1.1	Fri Apr  2 16:45:59 2004
+++ Packages/zpkgtools/doc/collections.txt	Fri Apr  2 18:09:22 2004
@@ -7,7 +7,7 @@
 
 Collection distributions contain one or more other distributions and
 the necessary support for installing all of the contained
-distributions.  The **zpkg** utility can build collection
+distributions.  The |zpkg|_ utility can build collection
 distributions containing package and collection distributions based on
 dependency information.
 
@@ -45,13 +45,13 @@
 Explanation
 -----------
 
-The top-level directory tree is populated by the **zpkg** tool itself,
+The top-level directory tree is populated by the |zpkg|_ tool itself,
 and does not contain any of the distributed materials.  Rather, it
-contains support material generated by **zpkg** to make the resulting
+contains support material generated by |zpkg|_ to make the resulting
 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**.
+(`setup.py`, `setup.cfg`, `MANIFEST`) are all generated by |zpkg|_.
 
 Within the top-level directory, a directory is created which contains
 the files of the collection itself (`Collection/` in this example).
@@ -78,7 +78,17 @@
 Additional files may be present in a collection; these are copied into
 the collection-specific directory directly unless `INCLUDES.txt`
 indicates they should not be distributed.  The `README.txt` file in
-this example is such a file.
+this example is such a file.  The files used by distutils will be
+generated and added to the directory as well.
+
+For each dependency that can be fulfilled (a location is specified in
+the `resource maps`_ loaded by |zpkg|_), an additional directory is
+added to the top-level directory.  The new directory will have the
+same name as the resource being included.  For collections, this
+directory will have the collection content and any distutils support
+files needed.  For packages, the contents of the directory are exactly
+the same as they would be for a separate package distribution build
+with |zpkg|_.
 
 
 Issues
@@ -97,3 +107,6 @@
   separate ZODB distribution (``ZEO``, ``zLOG``, ``ZConfig``, and a
   few others).  Given this limitation, the collection would need to
   have a different name (``ZODB3`` comes to mind).
+
+
+.. include:: links.rst