[Python-checkins] distutils2: minor: update setupcfg documentation

[tarek.ziade]

tarek.ziade pushed fcd52b00517a to distutils2:

http://hg.python.org/distutils2/rev/fcd52b00517a
changeset:   965:fcd52b00517a
tag:         tip
user:        Julien Jehannet <julien at smaf.org>
date:        Sun Jan 30 10:46:06 2011 +0100
summary:
  minor: update setupcfg documentation

files:
  docs/source/distutils/sourcedist.rst
  docs/source/setupcfg.rst

diff --git a/docs/source/distutils/sourcedist.rst b/docs/source/distutils/sourcedist.rst
--- a/docs/source/distutils/sourcedist.rst
+++ b/docs/source/distutils/sourcedist.rst
@@ -86,8 +86,7 @@
   distributions, but in the future there will be a standard for testing Python
   module distributions)
 
-* :file:`README.txt` (or :file:`README`), :file:`setup.py` (or whatever  you
-  called your setup script), and :file:`setup.cfg`
+* The configuration file :file:`setup.cfg`
 
 * all files that matches the ``package_data`` metadata.
   See :ref:`distutils-installing-package-data`.
@@ -95,6 +94,10 @@
 * all files that matches the ``data_files`` metadata.
   See :ref:`distutils-additional-files`.
 
+.. Warning::
+    In Distutils2, setup.py and README (or README.txt) files are not more
+    included in source distribution by default
+
 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
diff --git a/docs/source/setupcfg.rst b/docs/source/setupcfg.rst
--- a/docs/source/setupcfg.rst
+++ b/docs/source/setupcfg.rst
@@ -7,8 +7,8 @@
 
 Each section contains a description of its options.
 
-- Options that are marked *\*multi* can have multiple values, one value
-  per line.
+- Options that are marked *\*multi* can have multiple values, one value per
+  line.
 - Options that are marked *\*optional* can be omited.
 - Options that are marked *\*environ* can use environment markers, as described
   in :PEP:`345`.
@@ -49,7 +49,7 @@
   *\*optional* *\*multi*
 
 - **compilers**: Defined Distutils2 compiler. A compiler is defined by its fully
-  qualified name. 
+  qualified name.
 
   Example::
 
@@ -66,7 +66,8 @@
   Example::
 
     [global]
-    setup_hook = distutils2.tests.test_config.hook
+    setup_hook =
+        distutils2.tests.test_config.hook
 
 
 metadata
@@ -142,7 +143,7 @@
 
 .. Note::
     Some metadata fields seen in :PEP:`345` are automatically generated
-    as the Metadata-Version value for instance.
+    (for instance Metadata-Version value).
 
 
 files
@@ -170,6 +171,14 @@
 
     extra_files =
             setup.py
+            README
+
+.. Note::
+    In Distutils2, setup.cfg will be implicitly included.
+
+.. Warning::
+    In Distutils2, setup.py and README (or README.txt) files are not more
+    included in source distribution by default
 
 
 `command` sections
@@ -183,7 +192,7 @@
     manifest-builders = package.module.Maker
 
 
-To override the building class in order to compile your python2 files to python3::
+To override the build class in order to generate Python3 code from your Python2 base::
 
     [build_py]
     use-2to3 = True

--
Repository URL: http://hg.python.org/distutils2