Doc for -X dev option should mention PYTHONDEVMODE

[pitrou]

BPO	39712
Nosy	@pitrou, @vstinner, @ezio-melotti, @merwok, @willingc, @JulienPalard, @tirkarthi, @erlend-aasland, @rahul-kumi
PRs	bpo-39712: Cross reference env. vars and -X command line options #18685
Files	0001-bpo-39712.patch 0001-3.8-bpo-39712.patch 0001-3.7-bpo-39712.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-02-21.16:57:39.490>
labels = ['easy', '3.7', '3.8', '3.9', 'type-feature', 'docs']
title = 'Doc for `-X dev` option should mention PYTHONDEVMODE'
updated_at = <Date 2020-02-29.23:00:44.564>
user = 'https://github.com/pitrou'

bugs.python.org fields:

activity = <Date 2020-02-29.23:00:44.564>
actor = 'erlendaasland'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-02-21.16:57:39.490>
creator = 'pitrou'
dependencies = []
files = ['48926', '48927', '48928']
hgrepos = []
issue_num = 39712
keywords = ['patch', 'easy', 'newcomer friendly']
message_count = 4.0
messages = ['362414', '362525', '363025', '363030']
nosy_count = 10.0
nosy_names = ['pitrou', 'vstinner', 'ezio.melotti', 'eric.araujo', 'docs@python', 'willingc', 'mdk', 'xtreak', 'erlendaasland', 'rahul-kumi']
pr_nums = ['18685']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39712'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

Linked PRs

• GH-83893: Cross reference env. vars and -X command line options #103414
• [3.11] GH-83893: Cross reference env. vars and -X command line options (GH-103414) #103467

[pitrou]

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.

[rahul-kumi]

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.

[vstinner]

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."

[erlend-aasland]

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?

[furkanonder]

@erlend-aasland I think we can close that issue.

[erlend-aasland]

@erlend-aasland I think we can close that issue.

The issue mentioned by Antoine in the OP is not resolved yet :)

[furkanonder]

@erlend-aasland I think we can close that issue.

The issue mentioned by Antoine in the OP is not resolved yet :)

What does OP mean?

[erlend-aasland]

Sorry; Opening Post.

[merwok]

I improved help texts and cross-references in #100627 and #93219 but did not see this issue!
Will make a patch, or review one.

[vstinner]

I'm not sure which references are missing:

• -X faulthandler doc links to PYTHONFAULTHANDLER
• -X dev doc links to Python Development Mode which links to PYTHONDEVMODE
• -X tracemalloc doc links to PYTHONTRACEMALLOC
• PYTHONDEVMODE doc links to -X dev
• PYTHONTRACEMALLOC doc links to -X tracemalloc
• PYTHONFAULTHANDLER doc links to -X faulthandler

[vstinner]

I close the issue, please reopen it if something was missing.