diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2018-07-05 15:27:09 +0100 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2018-07-05 15:30:35 +0100 |
| commit | 3dc5ae566bd5b5b6824d0127142211022f378097 (patch) | |
| tree | 3eb7a80673ae93fe6d37c59adf8c6a89a0125760 | |
| parent | 73234c84b58d317c0a944a5fb5a47e59ad267e3d (diff) | |
| download | pbr-3dc5ae566bd5b5b6824d0127142211022f378097.tar.gz | |
Add docstring from LocalManifestMaker.add_defaults
A not-so-recent change to setuptools [1] has resulted in the inclusion
of a docstring from distutils that uses broken rST.
docstring of pbr.packaging.LocalManifestMaker.add_defaults:11:Definition
list ends without a blank line; unexpected unindent.
Resolve the issue by simply redefining the docstring.
[1] https://github.com/pypa/setuptools/compare/252ee6f...f1cf491f
[2] https://github.com/python/cpython/blob/3.4/Lib/distutils/command/sdist.py#L217-L229
Change-Id: I84b5097bc31af601061a77dfea9d6a6f38b018cc
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
| -rw-r--r-- | pbr/packaging.py | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/pbr/packaging.py b/pbr/packaging.py index 68df288..44bfb1a 100644 --- a/pbr/packaging.py +++ b/pbr/packaging.py @@ -488,6 +488,15 @@ class LocalManifestMaker(egg_info.manifest_maker): self.filelist.process_template_line(template_line) def add_defaults(self): + """Add all the default files to self.filelist: + + Extends the functionality provided by distutils to also included + additional sane defaults, such as the ``AUTHORS`` and ``ChangeLog`` + files generated by *pbr*. + + Warns if (``README`` or ``README.txt``) or ``setup.py`` are missing; + everything else is optional. + """ option_dict = self.distribution.get_option_dict('pbr') sdist.sdist.add_defaults(self) |