From 905b648754be0974f32cfd259bad7f6a7e3aebfb Mon Sep 17 00:00:00 2001 From: Petri Lehtinen Date: Sat, 23 Feb 2013 21:05:27 +0100 Subject: Issue #16403: Document how distutils uses the maintainer field in PKG-INFO --- 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 index 74fba4a..c4127bd 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 73ad78a..c4a89f0 100644 --- 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. -- cgit v0.12