Rename README to README.rst and enhance formatting #2

vstinner · 2017-02-10T22:41:59Z

README.rst is recognized by GitHub which will render the README as reStructured text (nice!), instead of plain text.

Example with my tiny project https://github.com/haypo/perf which has a README.rst file.

vstinner · 2017-02-10T22:50:38Z

I checked if the "README" file was referenced directly somewhere: I only found Makefile.pre.in.

zware · 2017-02-10T22:52:33Z

This could use some additional formatting enhancement, such as changing things like "./configure --help" to

``./configure --help``

Also, links can be turned into linked text rather than written out URLs.

vstinner · 2017-02-10T23:09:16Z

@zware: I hesitated, but ok: I made these changes.

I also added a link to the python-ideas mailing list, and I updated the Release Schedule to the Python 3.7 PEP.

merwok · 2017-02-11T00:31:05Z

README.rst



 Release Schedule
 ----------------

-See PEP 494 for release details: https://www.python.org/dev/peps/pep-0494/
+See `PEP 537 <https://www.python.org/dev/peps/pep-0537/>`_ for Python 3.7


Basic reST supports :pep:'537' (replace quotes with backticks because lol markdown)

I tried locally using rst2html tool. Sadly, this tool uses the old HTTP link, whereas www.python.org moved to HTTPS. I prefer to use HTTPS.

We should see which one Github uses, if either :)

https://github.com/github/markup/blob/cf74e842dfd082d8001417c1bb94edd2ae06d61b/lib/github/commands/rest2html AFAIK

Damn! docutils predates universal HTTPS.

zware

A couple of minor things, but mostly looks good!

zware · 2017-02-11T01:08:16Z

README.rst

 Python executable in a place that is not normally on your PATH, you may want to
-set up a symlink in /usr/local/bin.
+set up a symlink in ``/usr/local/bin``.

 On Windows, see PCbuild/readme.txt.


We could link to the actual file (https://github.com/python/cpython/blob/master/PCbuild/readme.txt).

Such change are out of the scope of my initial change. I suggest to make more enhancements in a second change.

zware · 2017-02-11T01:08:16Z

README.rst

-primary version, you would execute "make install" in your 3.7 build directory
-and "make altinstall" in the others.
+primary version, you would execute ``make install`` in your 3.7 build directory
+and ``make altinstall`` in the others.


 Issue Tracker and Mailing List
 ------------------------------

 We're soliciting bug reports about all aspects of the language.  Fixes are also
 welcome, preferably in unified diff format.  Please use the issue tracker:


This whole section can use updating:

Bug reports are welcome! You can use the `issue tracker <https://bugs.python.org>`_ to report bugs, and/or submit pull requests `on Github <https://github.com/python/cpython>`_. You can also follow development discussion on the `python-dev mailing list <https://mail.python.org/mailman/listinfo/python-dev/>`_.

zware · 2017-02-11T01:08:16Z

README.rst



 Release Schedule
 ----------------

-See PEP 494 for release details: https://www.python.org/dev/peps/pep-0494/
+See `PEP 537 <https://www.python.org/dev/peps/pep-0537/>`_ for Python 3.7


We should see which one Github uses, if either :)

Update also the Release Schedule to Python 3.7.

codecov · 2017-02-11T01:14:27Z

Codecov Report

❗ No coverage uploaded for pull request base (master@4538ddc). Click here to learn what that means.

@@            Coverage Diff            @@
##             master       #2   +/-   ##
=========================================
  Coverage          ?   82.37%           
=========================================
  Files             ?     1427           
  Lines             ?   350948           
  Branches          ?        0           
=========================================
  Hits              ?   289087           
  Misses            ?    61861           
  Partials          ?        0

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4538ddc...a44be7d. Read the comment docs.

vstinner · 2017-02-11T01:15:45Z

Ok, it seems like Eric and Zach want :pep:537: so I made this change.

But I prefer to restrict this change to converting README to README.rst and fix/enhance reST syntax. If you want to more general update/enhancements of README, I suggest to work on a new change based on mine.

zware

Fair enough :)

vstinner · 2017-02-11T02:03:36Z

And the winner is .... http://www.python.org/dev/peps/pep-0537 => HTTP link. But since each change now requires a PR, I'm not interested to write a PR just to replace HTTP with HTTPS :-p

zware · 2017-02-11T02:28:53Z

I'd recommend to report that as a bug to Github :). It is at least redirected to https automatically.

Includes GH-2, pythonGH-70, pythonGH-73, and pythonGH-21.

Includes GH-2, GH-70, GH-73 (GH-79), and GH-21.

Mariatta · 2017-02-25T19:28:18Z

Do we want to backport this to 3.5 and 2.7?

vstinner · 2017-02-25T20:13:57Z

This change causes issues with Windows installer, check with Steve Dower (sorry I don't recall the bpo number).

Mariatta · 2017-02-25T21:11:36Z

Thanks @Haypo . I saw the messages in http://bugs.python.org/issue29579. Seems like we won't be backporting readme changes to 3.5 and 2.7.
I'll remove the labels.

``` Direct leak of 8 byte(s) in 1 object(s) allocated from: #0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667) #1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774 #2 0xe0305b in cfunction_call Objects/methodobject.c:546 ``` Signed-off-by: Christian Heimes <christian@python.org>

``` Direct leak of 8 byte(s) in 1 object(s) allocated from: GH-0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667) GH-1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774 GH-2 0xe0305b in cfunction_call Objects/methodobject.c:546 ``` Signed-off-by: Christian Heimes <christian@python.org> (cherry picked from commit 0d3350d) Co-authored-by: Christian Heimes <christian@python.org>

``` Direct leak of 8 byte(s) in 1 object(s) allocated from: #0 0x7f008bf19667 in __interceptor_malloc (/lib64/libasan.so.6+0xb0667) #1 0x7f007a0bee4a in subprocess_fork_exec /home/heimes/dev/python/cpython/Modules/_posixsubprocess.c:774 python#2 0xe0305b in cfunction_call Objects/methodobject.c:546 ``` Signed-off-by: Christian Heimes <christian@python.org>

3.9

3: Add warnings for numbers r=vext01 a=nanjekyejoannah This has several changes, after git playing games with me, I managed to split the commits instead of committing one long one, as I had done before. *First commit*: Adds warnings for when the suffix "L" is used with numbers but also adds a custom Exception for our work suggested in the review of python#2 , called `Py3xWarning`. I should have committed the exception separately though. *Second commit*: Add warnings for octal literals. I fixed a test too Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>

6: Add warnings for the print statement r=ltratt a=nanjekyejoannah A Py3k syntax warning has been added for the print statement. This PR should replace python#2 Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>

Fix an uninitialized bool in exception print context. `struct exception_print_context.need_close` was uninitialized. Found by oss-fuzz in a test case running under the undefined behavior sanitizer. https://oss-fuzz.com/testcase-detail/6217746058182656 ``` Python/pythonrun.c:1241:28: runtime error: load of value 253, which is not a valid value for type 'bool' #0 0xbf2203 in print_chained cpython3/Python/pythonrun.c:1241:28 #1 0xbea4bb in print_exception_cause_and_context cpython3/Python/pythonrun.c:1320:19 #2 0xbea4bb in print_exception_recursive cpython3/Python/pythonrun.c:1470:13 #3 0xbe9e39 in _PyErr_Display cpython3/Python/pythonrun.c:1517:9 ``` Pretty obvious what the ommission was upon code inspection.

the-knights-who-say-ni added the CLA signed label Feb 10, 2017

vstinner force-pushed the README branch from 56262e3 to 8d6386d Compare Feb 10, 2017

vstinner force-pushed the README branch from 8d6386d to a9180b1 Compare Feb 10, 2017

refi64 mentioned this pull request Feb 10, 2017

Convert READMEs to rst #5

Closed

merwok reviewed Feb 11, 2017

View changes

zware requested changes Feb 11, 2017

View changes

Rename README to README.rst and enhance formatting

a44be7d

Update also the Release Schedule to Python 3.7.

vstinner force-pushed the README branch from a9180b1 to a44be7d Compare Feb 11, 2017

zware approved these changes Feb 11, 2017

View changes

vstinner merged commit d783b01 into python:master Feb 11, 2017

vstinner deleted the README branch Feb 11, 2017

nedbat mentioned this pull request Feb 11, 2017

Rename Doc/README.txt to Doc/README.rst #18

Closed

zware referenced this pull request in zware/cpython Feb 14, 2017

Backport master's README.rst to 3.6

37c0cb7

Includes GH-2, pythonGH-70, pythonGH-73, and pythonGH-21.

zware mentioned this pull request Feb 14, 2017

Backport master's README.rst to 3.6 #86

Merged

zware added a commit that referenced this pull request Feb 15, 2017

Backport master's README.rst to 3.6 (GH-86)

1e8cc88

Includes GH-2, GH-70, GH-73 (GH-79), and GH-21.

vstinner mentioned this pull request Feb 15, 2017

Rename Doc/README.txt to Doc/README.rst and add formatting #104

Merged

Mariatta added needs backport to 2.7 labels Feb 25, 2017

Mariatta removed needs backport to 2.7 labels Feb 25, 2017

tiran mentioned this pull request Jun 12, 2020

bpo-40955: Fix memory leak in subprocess module #20825

Merged

This was referenced Jun 12, 2020

[3.9] bpo-40955: Fix memory leak in subprocess module (GH-20825) #20831

Merged

[3.8] bpo-40955: Fix memory leak in subprocess module (GH-20825) #20832

Closed

miss-islington mentioned this pull request Jun 12, 2020

[3.7] bpo-40955: Fix memory leak in subprocess module (GH-20825) #20833

Closed

pablogsal mentioned this pull request Jun 12, 2020

bpo-40958: Avoid buffer overflow in the parser when indexing the current line #20842

Closed

shihai1991 mentioned this pull request Jun 23, 2020

bpo-1635741: Enable unicode_release_interned() without insure or valgrind. #21087

Closed

taleinat mentioned this pull request Oct 13, 2020

bpo-37903: IDLE: Shell sidebar with prompts (take #2) #22682

Merged

holzschu referenced this pull request in holzschu/cpython Nov 23, 2020

Merge pull request #2 from holzschu/3.9

f777131

3.9

ericsnowcurrently mentioned this pull request Sep 10, 2021

bpo-45020: Freeze the modules imported during startup. #28107

Closed

Livius90 added a commit to Livius90/cpython that referenced this pull request Sep 11, 2021

python#2 Try to fix Address sanitizer test issue

b1ccdba

thatbirdguythatuknownot referenced this pull request in thatbirdguythatuknownot/cpython Sep 14, 2021

Barry-related update #2

d8bfea5

thatbirdguythatuknownot mentioned this pull request Jan 25, 2022

bpo-46407: Optimizing power-of-2 operations #30628

Closed

jdevries3133 mentioned this pull request Feb 9, 2022

bpo-19217: Speed up assertEqual on long sequences #27434

Open

markshannon mentioned this pull request May 9, 2022

bpo-46841: Don't jump during throw() #31968

Closed

larryhastings mentioned this pull request Jun 7, 2022

The Great Argument Clinic Conversion Derby Meta-Issue #64386

Closed

itachaaa mentioned this pull request Aug 22, 2022

Python 3.10 hang at exit in drop_gil() (due to resource warning at exit?) #91414

Open

mdboom mentioned this pull request Aug 25, 2022

Assert and incorrect error message when loading source file containing invalid UTF-8 #96268

Closed

stevendaprano mentioned this pull request Oct 11, 2022

list.copy() #97697

Closed

Rename README to README.rst and enhance formatting #2

Rename README to README.rst and enhance formatting #2

vstinner commented Feb 10, 2017 •

edited

vstinner commented Feb 10, 2017

zware commented Feb 10, 2017

vstinner commented Feb 10, 2017

merwok Feb 11, 2017

vstinner Feb 11, 2017

zware Feb 11, 2017

dstufft Feb 11, 2017

merwok Feb 12, 2017

zware left a comment

zware Feb 11, 2017

vstinner Feb 11, 2017

zware Feb 11, 2017

vstinner Feb 11, 2017

zware Feb 11, 2017

codecov bot commented Feb 11, 2017

vstinner commented Feb 11, 2017

zware left a comment

vstinner commented Feb 11, 2017

zware commented Feb 11, 2017

Mariatta commented Feb 25, 2017

vstinner commented Feb 25, 2017

Mariatta commented Feb 25, 2017

Rename README to README.rst and enhance formatting #2

Rename README to README.rst and enhance formatting #2

Conversation

vstinner commented Feb 10, 2017 • edited

vstinner commented Feb 10, 2017

zware commented Feb 10, 2017

vstinner commented Feb 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zware left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Feb 11, 2017

Codecov Report

vstinner commented Feb 11, 2017

zware left a comment

vstinner commented Feb 11, 2017

zware commented Feb 11, 2017

Mariatta commented Feb 25, 2017

vstinner commented Feb 25, 2017

Mariatta commented Feb 25, 2017

vstinner commented Feb 10, 2017 •

edited