Visitar URL original
gh-159010: Fix spelling of -X disable-remote-debug in docs by abhishekacharya200 · Pull Request #159014 · python/cpython · GitHub
Skip to content

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

Open
abhishekacharya200 wants to merge 1 commit into
python:mainfrom
abhishekacharya200:gh-159010-disable-remote-debug-docs
Open

abhishekacharya200 wants to merge 1 commit into
python:mainfrom
abhishekacharya200:gh-159010-disable-remote-debug-docs

Conversation

@abhishekacharya200

@abhishekacharya200 abhishekacharya200 commented Oct 8, 2026 •

Copy link
Copy Markdown

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant