Skip to content

Update manpage environment variables and command line arguments - #129623

Merged
hugovk merged 25 commits into
python:mainfrom
stefanor:envvars-manpage
Feb 12, 2025
Merged

Update manpage environment variables and command line arguments#129623
hugovk merged 25 commits into
python:mainfrom
stefanor:envvars-manpage

Conversation

@stefanor

@stefanorstefanor commented Feb 3, 2025

Copy link
Copy Markdown
Contributor

We got a bug report in Debian for missing PYTHON_BASIC_REPL documentation

The manpage is a bit out of date from the Sphinx docs, when it comes to environment variables and -X command line options.

Bring it back up to date.

I excluded windows-only options, as manpages are probably not relevant on that platform.

@stefanor
Document PYTHONPYCACHEPREFIX in the manpage
1d05d84
@stefanor
Document PYTHONCOERCELOCALE in the manpage
baf369c
@stefanor
Document PYTHONDEVMODE in the manpage
05a5279
@stefanor
Document PYTHONUTF8 in the manpage
24e2f70
@stefanor
Document PYTHONWARNDEFAULTENCODING in the manpage
282e490
@stefanor
Document PYTHONNODEBUGRANGES in the manpage
0ca6b15
@stefanor
Document PYTHONPERFSUPPORT in the manpage
4c31a4f
@stefanor
Document PYTHON_PERF_JIT_SUPPORT in the manpage
9280498
@stefanor
Document PYTHON_CPU_COUNT in the manpage
9363383
@stefanor
Document PYTHON_FROZEN_MODULES in the manpage
c8456d1
@stefanor
Document PYTHON_BASIC_REPL in the manpage
a41dbec
@stefanor
Document PYTHONDUMPREFSFILE in the manpage
d5f2508
@stefanor
Document PYTHON_PRESITE in the manpage
fd595b4
@stefanor
Document the -R option in the manpage
995268d
@stefanor
Mention that int_max_str_digits is equivalent to PYTHONINTMAXSTRDIGIT…
3169524
…S in the manpage
@stefanor
Document -X perf in the manpage
a715cfe
@stefanor
Document -X perf_jit in --help-xoptions
b7006c3
@stefanor
Document -X perf_jit in the manpage
f3f24ce
@stefanor
Document -X cpu_count in the manpage
c83ede7
@stefanor
Document -X presite in the manpage
60290c1
@stefanor
Document the -X gil option in the manpage
682aca2
@picnixz

picnixz commented Feb 4, 2025

Copy link
Copy Markdown
Member

I was searching for an issue to use but unless you want to create one with the same text as in the PR, I think we can skip the issue.

We could create an issue though if we want to communicate that the manpage documentation is now up-to-date but it might be unnecessary.

@picnixz
picnixz requested review from AA-Turner and hugovk and removed request for ericsnowcurrentlyFebruary 4, 2025 09:45
@hugovk

hugovk commented Feb 4, 2025

Copy link
Copy Markdown
Member

Thanks for the update!

How can I build and view the output of this PR?

@picnixz

picnixz commented Feb 4, 2025•
edited
Loading

Copy link
Copy Markdown
Member

Otherwise nroff -man file.man | more -s (maybe groff can be used as well)

@picnixz

picnixz commented Feb 4, 2025•
edited
Loading

Copy link
Copy Markdown
Member

Oh if you want the full build, I think you need to install entirely, including the docs though I don't remember which target it is. Then use man directly (maybe you need to change some search paths just to avoid getting the manpage of your system-wide python)

hugovk
hugovk reviewed Feb 11, 2025
View reviewed changes
Comment threadMisc/python.man Outdated
Comment on lines +370 to +371
-X gil=[0|1]: enable (1) or disable (0) the GIL; also PYTHON_GIL
Only available in builds configured with --disable-gil.

@hugovkhugovkFeb 11, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noting this one is shown for python3.14t --help-all and not python3.14 --help-all, but the same applies to PYTHON_GIL and we already have that in this file.

@stefanorstefanorFeb 11, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think we have to include everything (or have multiple manpages).

Comment threadMisc/python.man Outdated
Comment threadMisc/python.man Outdated
@stefanor
stefanor requested a review from hugovkFebruary 11, 2025 15:01
@hugovk

hugovk commented Feb 11, 2025

Copy link
Copy Markdown
Member

(Updated from main to fix the change detection we changed recently)

hugovk
hugovk approved these changes Feb 11, 2025
View reviewed changes

@hugovkhugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@hugovk
hugovk merged commit e1b38ea into python:mainFeb 12, 2025
@hugovk

hugovk commented Feb 12, 2025

Copy link
Copy Markdown
Member

This has some 3.13-only things, shall we only backport to 3.13? Or also 3.12?

(I won't be surprised if there'll be conflicts anyway for 3.13.)

@stefanor
stefanor deleted the envvars-manpage branch February 12, 2025 12:18
@stefanor

stefanor commented Feb 12, 2025

Copy link
Copy Markdown
ContributorAuthor

I'm happy to review the lists again and prepare backports, if that helps.

@hugovk

hugovk commented Feb 13, 2025

Copy link
Copy Markdown
Member

Thanks, I don't mind too much either way, let's see if the bot can do the backport for 3.13...

@hugovkhugovk added the needs backport to 3.13 bugs and security fixes label Feb 13, 2025
@miss-islington-app

miss-islington-appBot commented Feb 13, 2025

Copy link
Copy Markdown

Thanks @stefanor for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 13, 2025
@stefanor@hugovk@miss-islington
Update manpage environment variables and command line arguments (pyth…
b56970c
…onGH-129623)
(cherry picked from commit e1b38ea)
Co-authored-by: Stefano Rivera <stefano@rivera.za.net>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app

bedevere-appBot commented Feb 13, 2025

Copy link
Copy Markdown

GH-130078 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label Feb 13, 2025
@hugovk

hugovk commented Feb 13, 2025

Copy link
Copy Markdown
Member

It worked!

hugovk
hugovk reviewed Feb 13, 2025
View reviewed changes
Comment threadMisc/python.man
stefanor added a commit to stefanor/cpython that referenced this pull request Feb 13, 2025
@stefanor
Correct typo inpythonGH-129623
f02d2f8
hugovk added a commit that referenced this pull request Feb 13, 2025
@miss-islington@stefanor@hugovk
[3.13] Update manpage environment variables and command line arguments (
9e23e0a
GH-129623) (#130078)
Co-authored-by: Stefano Rivera <stefano@rivera.za.net>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Feb 14, 2025
@stefanor@hugovk
Correct typo inGH-129623(#130079)
6666b38
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@stefanorstefanor mentioned this pull request May 9, 2025
Merged
stefanor added a commit to stefanor/cpython that referenced this pull request May 9, 2025
@stefanor
Manpage: -X gil is not related to PYTHON_HISTORY
05b5db4
This corrects a mistake I made, when sorting environment variables in
pythonGH-129623.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovkhugovkhugovk approved these changes
@AA-TurnerAA-TurnerAwaiting requested review from AA-Turner

Assignees

No one assigned

Labels

skip issueskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@stefanor@picnixz@hugovk