classification
Title: Doc for `-X dev` option should mention PYTHONDEVMODE
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.9, Python 3.8, Python 3.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, erlendaasland, ezio.melotti, mdk, pitrou, rahul-kumi, vstinner, willingc, xtreak
Priority: normal Keywords: easy, newcomer friendly, patch

Created on 2020-02-21 16:57 by pitrou, last changed 2020-02-29 23:00 by erlendaasland.

Files
File name Uploaded Description Edit
0001-bpo-39712.patch erlendaasland, 2020-02-28 10:24
0001-3.8-bpo-39712.patch erlendaasland, 2020-02-28 10:24
0001-3.7-bpo-39712.patch erlendaasland, 2020-02-28 10:24
Pull Requests
URL Status Linked Edit
PR 18685 open erlendaasland, 2020-02-28 10:32
Messages (4)
msg362414 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2020-02-21 16:57
In the doc for `-X` options (https://docs.python.org/3/using/cmdline.html#id5), when an option can be triggered through an equivalent environment variable, that variable is mentioned.

An exception to that is `-X dev`, which can also be triggered by the PYTHONDEVMODE variable, but that isn't mentioned in the CLI doc.

Other missing environment variables in the CLI doc are PYTHONFAULTHANDLER and PYTHONTRACEMALLOC.
msg362525 - (view) Author: Rahul Kumaresan (rahul-kumi) * Date: 2020-02-23 17:07
I would like to work on this issue.
Can you please suggest me specifics that I should be considering before I update the doc with the suggested inclusions.
msg363025 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2020-02-29 22:40
> An exception to that is `-X dev`, which can also be triggered by the PYTHONDEVMODE variable, but that isn't mentioned in the CLI doc.

I wrote a whole new page for -X dev: https://docs.python.org/dev/library/devmode.html#devmode

This page starts with:

"It can be enabled using the -X dev command line option or by setting the PYTHONDEVMODE environment variable to 1."
msg363030 - (view) Author: Erlend Egeberg Aasland (erlendaasland) * Date: 2020-02-29 23:00
> I wrote a whole new page for -X dev: https://docs.python.org/dev/library/devmode.html#devmode

That's nice, but references for PYTHONFAULTHANDLER and PYTHONTRACEMALLOC are still missing. If you think the cross refs for -X dev and PYTHONDEVMODE clutters cmdline.html, I'll remove them from the PR.

Is it worth it adding https://docs.python.org/dev/library/devmode.html to 3.8 and possibly 3.7 as well?
History
Date User Action Args
2020-02-29 23:00:44erlendaaslandsetmessages: + msg363030
2020-02-29 22:40:52vstinnersetmessages: + msg363025
2020-02-28 10:32:21erlendaaslandsetnosy: + erlendaasland

pull_requests: + pull_request18045
stage: needs patch -> patch review
2020-02-28 10:24:54erlendaaslandsetfiles: + 0001-3.7-bpo-39712.patch
2020-02-28 10:24:45erlendaaslandsetfiles: + 0001-3.8-bpo-39712.patch
2020-02-28 10:24:35erlendaaslandsetfiles: + 0001-bpo-39712.patch
keywords: + patch
2020-02-24 04:50:34xtreaksetnosy: + xtreak
2020-02-23 17:07:09rahul-kumisetnosy: + rahul-kumi
messages: + msg362525
2020-02-21 16:57:39pitroucreate