[Python-checkins] cpython (2.7): Issue #16403: Document how distutils uses the maintainer field in PKG-INFO

[petri.lehtinen]

http://hg.python.org/cpython/rev/14144373fdcd
changeset:   82360:14144373fdcd
branch:      2.7
parent:      82356:2b96dcdac419
user:        Petri Lehtinen <petri at digip.org>
date:        Sat Feb 23 21:05:27 2013 +0100
summary:
  Issue #16403: Document how distutils uses the maintainer field in PKG-INFO

files:
  Doc/distutils/apiref.rst      |  5 ++++-
  Doc/distutils/setupscript.rst |  3 ++-
  Misc/NEWS                     |  3 +++
  3 files changed, 9 insertions(+), 2 deletions(-)


diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -48,7 +48,10 @@
    +--------------------+--------------------------------+-------------------------------------------------------------+
    | *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
--- a/Doc/distutils/setupscript.rst
+++ b/Doc/distutils/setupscript.rst
@@ -598,7 +598,8 @@
     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
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -926,6 +926,9 @@
 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.
 

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