From: Petri Lehtinen <petri@digip.org>
Date: Sat, 23 Feb 2013 20:05:27 +0000 (+0100)
Subject: Issue #16403: Document how distutils uses the maintainer field in PKG-INFO
X-Git-Tag: v2.7.4rc1~78
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fead3c8cca461e0fc2ce3f37dcb7d5260edbdddd;p=thirdparty%2FPython%2Fcpython.git

Issue #16403: Document how distutils uses the maintainer field in PKG-INFO
---

diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index 76567ad73546..b37e02cb6873 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 165bfcd71679..58f3149d58f1 100644
--- a/Doc/distutils/setupscript.rst
+++ b/Doc/distutils/setupscript.rst
@@ -598,7 +598,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 9f2a2bed90b7..a2f397ca9c7f 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -926,6 +926,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.