[Zope-CVS] CVS: Packages/zpkgtools/doc - metadata.txt:1.24

[Fred L. Drake, Jr.]

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

Modified Files:
	metadata.txt 
Log Message:
add a <data-files> section type for SETUP.cfg files; this allows installation
arbitrary files using the "normal" distutils notion of data files
(not completely hooked up yet)


=== Packages/zpkgtools/doc/metadata.txt 1.23 => 1.24 ===
--- Packages/zpkgtools/doc/metadata.txt:1.23	Fri May  7 15:01:02 2004
+++ Packages/zpkgtools/doc/metadata.txt	Tue May 11 16:09:41 2004
@@ -257,3 +257,36 @@
     #undef ANOTHER
 
   at the top of the compilation unit.
+
+Installing Additional Files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Files that would traditionally be installed by identifying them in the
+``data_files`` keyword argument to the ``distutils.core.setup()``
+function may be identified using `SETUP.cfg` as well.
+
+A series of **<data-files>** sections can be used for this purpose;
+one section should be given for each destination directory.  Each line
+of the section should give a glob pattern specifying files that should
+be installed in the directory identified by the name of the section.
+
+For example, this section::
+
+  <data-files etc>
+    myapp.conf
+  </data-files>
+
+will cause the file `myapp.conf`, found in the same directory as the
+`SETUP.cfg` which includes this section, to be copied to
+`$prefix/etc/myapp.conf`.
+
+This section::
+
+  <data-files etc/myapp>
+    default-config/*
+  </data-files>
+
+will cause all the files in the `default-config` directory (a sibling
+of the `SETUP.cfg` file containing this section) to be copied into the
+directory `$prefix/etc/myapp/`; this directory will be created if
+necessary.