summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPetri Lehtinen <petri@digip.org>2013-02-23 20:09:12 (GMT)
committerPetri Lehtinen <petri@digip.org>2013-02-23 20:09:12 (GMT)
commit7de72ad8a02760e0aa385e9024d6c20d7b1fb3de (patch)
tree00d8f9c311d562c6b663dc49647643b50b68d766
parente2c114733b1c9dc3a78c6723934e523e5260e156 (diff)
parent905b648754be0974f32cfd259bad7f6a7e3aebfb (diff)
downloadcpython-7de72ad8a02760e0aa385e9024d6c20d7b1fb3de.zip
cpython-7de72ad8a02760e0aa385e9024d6c20d7b1fb3de.tar.gz
cpython-7de72ad8a02760e0aa385e9024d6c20d7b1fb3de.tar.bz2
Issue #16403: Document how distutils uses the maintainer field in PKG-INFO
-rw-r--r--Doc/distutils/apiref.rst5
-rw-r--r--Doc/distutils/setupscript.rst3
-rw-r--r--Misc/NEWS3
3 files changed, 9 insertions, 2 deletions
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index 106cc52..1381afc 100644
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -48,7 +48,10 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
+--------------------+--------------------------------+-------------------------------------------------------------+
| *maintainer* | The name of the current | a string |
| | maintainer, if different from | |
- | | the author | |
+ | | the author. Note that if | |
+ | | the maintainer is provided, | |
+ | | distutils will use it as the | |
+ | | author in :file:`PKG-INFO` | |
+--------------------+--------------------------------+-------------------------------------------------------------+
| *maintainer_email* | The email address of the | a string |
| | current maintainer, if | |
diff --git a/Doc/distutils/setupscript.rst b/Doc/distutils/setupscript.rst
index 8029243..ba78107 100644
--- a/Doc/distutils/setupscript.rst
+++ b/Doc/distutils/setupscript.rst
@@ -601,7 +601,8 @@ Notes:
It is recommended that versions take the form *major.minor[.patch[.sub]]*.
(3)
- Either the author or the maintainer must be identified.
+ Either the author or the maintainer must be identified. If maintainer is
+ provided, distutils lists it as the author in :file:`PKG-INFO`.
(4)
These fields should not be used if your package is to be compatible with Python
diff --git a/Misc/NEWS b/Misc/NEWS
index 16e4d54..258c549 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -756,6 +756,9 @@ Tools/Demos
Documentation
-------------
+- Issue #16403: Document how distutils uses the maintainer field in
+ PKG-INFO. Patch by Jyrki Pulliainen.
+
- Issue #16695: Document how glob handles filenames starting with a
dot. Initial patch by Jyrki Pulliainen.