bpo-11913: Add README.rst to the distutils standard READMEs list (#563) · python/cpython@f9f87f0 (original) (raw)

4 files changed

lines changed

Original file line number Diff line number Diff line change
@@ -95,8 +95,9 @@ source distribution:
95 95 distributions, but in the future there will be a standard for testing Python
96 96 module distributions)
97 97
98 -* :file:`README.txt` (or :file:`README`), :file:`setup.py` (or whatever you
99 - called your setup script), and :file:`setup.cfg`
98 +* Any of the standard README files (:file:`README`, :file:`README.txt`,
99 + or :file:`README.rst`), :file:`setup.py` (or whatever you called your setup
100 + script), and :file:`setup.cfg`.
100 101
101 102 * all files that matches the ``package_data`` metadata.
102 103 See :ref:`distutils-installing-package-data`.
@@ -130,6 +131,9 @@ described above does not apply in this case.
130 131 :command:`sdist` will read a :file:`MANIFEST` file if no :file:`MANIFEST.in`
131 132 exists, like it used to do.
132 133
134 +.. versionchanged:: 3.7
135 +:file:`README.rst` is now included in the list of distutils standard READMEs.
136 +
133 137
134 138 The manifest template has one command per line, where each command specifies a
135 139 set of files to include or exclude from the source distribution. For an
Original file line number Diff line number Diff line change
@@ -95,6 +95,13 @@ New Modules
95 95 Improved Modules
96 96 ================
97 97
98 +distutils
99 +---------
100 +
101 +README.rst is now included in the list of distutils standard READMEs and
102 +therefore included in source distributions.
103 +(Contributed by Ryan Gonzalez in :issue:`11913`.)
104 +
98 105 http.server
99 106 -----------
100 107
Original file line number Diff line number Diff line change
@@ -96,7 +96,7 @@ def checking_metadata(self):
96 96
97 97 sub_commands = [('check', checking_metadata)]
98 98
99 -READMES = 'README', 'README.txt'
99 +READMES = ('README', 'README.txt', 'README.rst')
100 100
101 101 def initialize_options(self):
102 102 # 'template' and 'manifest' are, respectively, the names of
Original file line number Diff line number Diff line change
@@ -10,6 +10,9 @@ What's New in Python 3.7.0 alpha 1?
10 10 Core and Builtins
11 11 -----------------
12 12
13 +- bpo-11913: README.rst is now included in the list of distutils standard
14 + READMEs and therefore included in source distributions.
15 +
13 16 - bpo-29914: Fixed default implementations of __reduce__ and __reduce_ex__().
14 17 object.__reduce__() no longer takes arguments, object.__reduce_ex__() now
15 18 requires one argument.
@@ -310,12 +313,12 @@ Library
310 313 - bpo-29694: Fixed race condition in pathlib mkdir with flags
311 314 parents=True. Patch by Armin Rigo.
312 315
313 -- bpo-29692: Fixed arbitrary unchaining of RuntimeError exceptions in
316 +- bpo-29692: Fixed arbitrary unchaining of RuntimeError exceptions in
314 317 contextlib.contextmanager.
315 318 Patch by Siddharth Velankar.
316 319
317 320 - bpo-26187: Test that sqlite3 trace callback is not called multiple
318 - times when schema is changing. Indirectly fixed by switching to
321 + times when schema is changing. Indirectly fixed by switching to
319 322 use sqlite3_prepare_v2() in bpo-9303. Patch by Aviv Palivoda.
320 323
321 324 - bpo-30017: Allowed calling the close() method of the zip entry writer object