https://github.com/python/cpython/commit/cf0c41f716871a8d19d56916e0be59d3beb887d5 commit: cf0c41f716871a8d19d56916e0be59d3beb887d5 branch: 3.15 author: Miss Islington (bot) <[email protected]> committer: StanFromIreland <[email protected]> date: 2026-10-14T16:09:57+01:00 summary:
[3.15] gh-159010: Fix spelling of `-X disable-remote-debug` option in docs (GH-159014) (#159414) (cherry picked from commit 91248026c8a41910098032dd23f9a05ad2d9b513) Co-authored-by: Abhishek Acharya <[email protected]> files: M Doc/howto/remote_debugging.rst M Doc/using/cmdline.rst diff --git a/Doc/howto/remote_debugging.rst b/Doc/howto/remote_debugging.rst index 1a8e8593e8a60a9..f5f45c399ae1fff 100644 --- a/Doc/howto/remote_debugging.rst +++ b/Doc/howto/remote_debugging.rst @@ -16,7 +16,7 @@ To disable remote debugging support, use any of the following: * Set the :envvar:`PYTHON_DISABLE_REMOTE_DEBUG` environment variable to ``1`` before starting the interpreter. -* Use the :option:`-X disable_remote_debug` command-line option. +* Use the :option:`-X disable-remote-debug` command-line option. * Compile Python with the :option:`--without-remote-debug` build flag. .. _permission-requirements: @@ -717,7 +717,7 @@ When to use ``PYTHON_DISABLE_REMOTE_DEBUG`` ------------------------------------------- The environment variable :envvar:`PYTHON_DISABLE_REMOTE_DEBUG` (and the -equivalent :option:`-X disable_remote_debug` flag) allows operators to disable +equivalent :option:`-X disable-remote-debug` flag) allows operators to disable the in-process side of the protocol as a **defence-in-depth** measure. This may be useful in hardened or sandboxed deployment environments where no debugging or profiling of the process is expected and reducing attack surface diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 81447b9854bfdb1..780faf8ba00f7be 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -652,7 +652,7 @@ Miscellaneous options .. versionadded:: 3.13 - * ``-X disable_remote_debug`` disables the remote debugging support as described + * ``-X disable-remote-debug`` disables the remote debugging support as described in :pep:`768`. This includes both the functionality to schedule code for execution in another process and the functionality to receive code for execution in the current process. @@ -1316,7 +1316,7 @@ conflict. to schedule code for execution in another process and the functionality to receive code for execution in the current process. - See also the :option:`-X disable_remote_debug` command-line option. + See also the :option:`-X disable-remote-debug` command-line option. .. versionadded:: 3.14 _______________________________________________ Python-checkins mailing list -- [email protected] To unsubscribe send an email to [email protected] https://mail.python.org/mailman3//lists/python-checkins.python.org Member address: [email protected]
