diff options
| author | Petri Lehtinen <petri@digip.org> | 2013-02-23 20:05:27 (GMT) |
|---|---|---|
| committer | Petri Lehtinen <petri@digip.org> | 2013-02-23 20:06:16 (GMT) |
| commit | 905b648754be0974f32cfd259bad7f6a7e3aebfb (patch) | |
| tree | 53edcc7868b100402a9de75f69d4bb111905ff74 /Doc/distutils | |
| parent | ee4a20bad61b9315bb28e0162eefd7f0da110499 (diff) | |
| download | cpython-905b648754be0974f32cfd259bad7f6a7e3aebfb.zip cpython-905b648754be0974f32cfd259bad7f6a7e3aebfb.tar.gz cpython-905b648754be0974f32cfd259bad7f6a7e3aebfb.tar.bz2 | |
Issue #16403: Document how distutils uses the maintainer field in PKG-INFO
Diffstat (limited to 'Doc/distutils')
| -rw-r--r-- | Doc/distutils/apiref.rst | 5 | ||||
| -rw-r--r-- | Doc/distutils/setupscript.rst | 3 |
2 files changed, 6 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 |