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

This commit is contained in:
Petri Lehtinen 2013-02-23 21:09:12 +01:00
commit 7de72ad8a0
3 changed files with 9 additions and 2 deletions

View file

@ -48,7 +48,10 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
+--------------------+--------------------------------+-------------------------------------------------------------+ +--------------------+--------------------------------+-------------------------------------------------------------+
| *maintainer* | The name of the current | a string | | *maintainer* | The name of the current | a string |
| | maintainer, if different from | | | | 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 | | *maintainer_email* | The email address of the | a string |
| | current maintainer, if | | | | current maintainer, if | |

View file

@ -601,7 +601,8 @@ Notes:
It is recommended that versions take the form *major.minor[.patch[.sub]]*. It is recommended that versions take the form *major.minor[.patch[.sub]]*.
(3) (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) (4)
These fields should not be used if your package is to be compatible with Python These fields should not be used if your package is to be compatible with Python

View file

@ -756,6 +756,9 @@ Tools/Demos
Documentation 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 - Issue #16695: Document how glob handles filenames starting with a
dot. Initial patch by Jyrki Pulliainen. dot. Initial patch by Jyrki Pulliainen.