Skip to content

gh-159010: Fix spelling of -X disable-remote-debug in docs - #159014

Merged
StanFromIreland merged 1 commit into
python:mainfrom
abhishekacharya200:gh-159010-disable-remote-debug-docs
Oct 14, 2026
Merged

StanFromIreland merged 1 commit into
python:mainfrom
abhishekacharya200:gh-159010-disable-remote-debug-docs

Conversation

@abhishekacharya200

@abhishekacharya200 abhishekacharya200 commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

The docs spell the option as -X disable_remote_debug, but Python/initconfig.c only recognises disable-remote-debug (matching --help-xoptions and whatsnew/3.14.rst). Unknown -X options are silently ignored, so the documented spelling leaves remote debugging enabled.

$ python3.14 -X disable_remote_debug -c "import sys; print(sys.is_remote_debug_enabled())"
True
$ python3.14 -X disable-remote-debug -c "import sys; print(sys.is_remote_debug_enabled())"
False

This fixes the four occurrences in Doc/using/cmdline.rst and Doc/howto/remote_debugging.rst. Docs-only, so it should need skip news and a backport to 3.14.

@python-cla-bot

python-cla-bot Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35012309 | 📁 Comparing 962bff1 against main (b22a8c9)

  🔍 Preview build  

2 files changed
± howto/remote_debugging.html
± using/cmdline.html

@pablogsal

Copy link
Copy Markdown
Member

Thanks for the catch!

@StanFromIreland
StanFromIreland merged commit 9124802 into python:main Oct 14, 2026
41 checks passed
@StanFromIreland StanFromIreland added needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Oct 14, 2026
@miss-islington-app

Copy link
Copy Markdown

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

@miss-islington-app

Copy link
Copy Markdown

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

@bedevere-app

bedevere-app Bot commented Oct 14, 2026

Copy link
Copy Markdown

GH-159413 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Oct 14, 2026
@bedevere-app

bedevere-app Bot commented Oct 14, 2026

Copy link
Copy Markdown

GH-159414 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Oct 14, 2026
StanFromIreland pushed a commit that referenced this pull request Oct 14, 2026
… docs (GH-159014) (#159414)

(cherry picked from commit 9124802)

Co-authored-by: Abhishek Acharya <118182738+abhishekacharya200@users.noreply.github.com>
StanFromIreland pushed a commit that referenced this pull request Oct 14, 2026
… docs (GH-159014) (#159413)

(cherry picked from commit 9124802)

Co-authored-by: Abhishek Acharya <118182738+abhishekacharya200@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants