]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Issue #16403: Document how distutils uses the maintainer field in PKG-INFO
authorPetri Lehtinen <petri@digip.org>
Sat, 23 Feb 2013 20:05:27 +0000 (21:05 +0100)
committerPetri Lehtinen <petri@digip.org>
Sat, 23 Feb 2013 20:05:48 +0000 (21:05 +0100)
Doc/distutils/apiref.rst
Doc/distutils/setupscript.rst
Misc/NEWS

index 76567ad73546a90d56402ce9db2058e78ef0c772..b37e02cb6873d2bde1ea6bc1ed02ccd2c97910ea 100644 (file)
@@ -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         |                                                             |
index 165bfcd71679d0d4a6efd79c3709bf96cc8c4028..58f3149d58f18cf28d7953f66259a9cb8e4d7359 100644 (file)
@@ -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
index 9f2a2bed90b7826e6f287a776511113132d50945..a2f397ca9c7fb3bea8336c5aee04d9a367429b37 100644 (file)
--- 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.