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 74fba4ada7fa44f5ae419ebba8416384aca8de91..c4127bdbbf9b65d5d16e633df9be16257611b693 100644 (file)
--- 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 80292432a9cd4531e7141049a5ebcc2630e1d056..ba7810715ded87ce91f384146f130fcc0271c9e4 100644 (file)
--- 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 73ad78a888e760ff697ee8ba60eb5e764d40b788..c4a89f0713ac36f22c8eee5821af517c22294037 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -1078,6 +1078,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.