summaryrefslogtreecommitdiffstats
path: root/Doc/distutils
diff options
context:
space:
mode:
authorTarek Ziadé <ziade.tarek@gmail.com>2009-02-16 21:38:01 (GMT)
committerTarek Ziadé <ziade.tarek@gmail.com>2009-02-16 21:38:01 (GMT)
commit7dd533963fc947982e472db555cd0ee4b937c9cf (patch)
tree3d7f441fffb5e63b2d48a5f36bf99e95fdfdf071 /Doc/distutils
parenta7b0c12152e6268bb09b462f2a0fe52178ee6065 (diff)
downloadcpython-7dd533963fc947982e472db555cd0ee4b937c9cf.zip
cpython-7dd533963fc947982e472db555cd0ee4b937c9cf.tar.gz
cpython-7dd533963fc947982e472db555cd0ee4b937c9cf.tar.bz2
Fixed #2279: distutils.sdist.add_defaults now add files listed in package_data and data_files
Diffstat (limited to 'Doc/distutils')
-rw-r--r--Doc/distutils/setupscript.rst18
-rw-r--r--Doc/distutils/sourcedist.rst12
2 files changed, 30 insertions, 0 deletions
diff --git a/Doc/distutils/setupscript.rst b/Doc/distutils/setupscript.rst
index 9308288..8179031 100644
--- a/Doc/distutils/setupscript.rst
+++ b/Doc/distutils/setupscript.rst
@@ -427,6 +427,7 @@ The versions identified by the qualifiers are those that are obsoleted by the
distribution being described. If no qualifiers are given, all versions of the
named module or package are understood to be obsoleted.
+.. _distutils-installing-scripts:
Installing Scripts
==================
@@ -449,6 +450,12 @@ way. From the PyXML setup script::
scripts=['scripts/xmlproc_parse', 'scripts/xmlproc_val']
)
+All the scripts will also be added to the ``MANIFEST``
+file if no template is provided. See :ref:`manifest`.
+
+.. versionadded:: 2.7
+
+.. _distutils-installing-package-data:
Installing Package Data
=======================
@@ -492,6 +499,12 @@ The corresponding call to :func:`setup` might be::
.. versionadded:: 2.4
+All the files that match ``package_data`` will be added to the ``MANIFEST``
+file if no template is provided. See :ref:`manifest`.
+
+.. versionadded:: 2.7
+
+.. _distutils-additional-files:
Installing Additional Files
===========================
@@ -527,6 +540,11 @@ without specifying a target directory, but this is not recommended, and the
files directly in the target directory, an empty string should be given as the
directory.
+All the files that match ``data_files`` will be added to the ``MANIFEST``
+file if no template is provided. See :ref:`manifest`.
+
+.. versionadded:: 2.7
+
.. _meta-data:
diff --git a/Doc/distutils/sourcedist.rst b/Doc/distutils/sourcedist.rst
index 960cc0a..5c0e5d0 100644
--- a/Doc/distutils/sourcedist.rst
+++ b/Doc/distutils/sourcedist.rst
@@ -74,6 +74,7 @@ source distribution:
:meth:`get_source_files` method in :file:`build_clib.py`! **\*\***)
* scripts identified by the :option:`scripts` option
+ See :ref:`distutils-installing-scripts`.
* anything that looks like a test script: :file:`test/test\*.py` (currently, the
Distutils don't do anything with test scripts except include them in source
@@ -83,6 +84,17 @@ source distribution:
* :file:`README.txt` (or :file:`README`), :file:`setup.py` (or whatever you
called your setup script), and :file:`setup.cfg`
+* all files that matches the ``package_data`` metadata.
+ See :ref:`distutils-installing-package-data`.
+
+ .. versionadded:: 2.7
+
+* all files that matches the ``data_files`` metadata.
+ See :ref:`distutils-additional-files`.
+
+ .. versionadded:: 2.7
+
+
Sometimes this is enough, but usually you will want to specify additional files
to distribute. The typical way to do this is to write a *manifest template*,
called :file:`MANIFEST.in` by default. The manifest template is just a list of