From affa1fc6f9433daee3fa802f77405345df9a14ae Mon Sep 17 00:00:00 2001 From: Abhishek Acharya <118182738+abhishekacharya200@users.noreply.github.com> Date: Wed, 14 Oct 2026 19:03:19 +0545 Subject: [PATCH] gh-159010: Fix spelling of `-X disable-remote-debug` option in docs (GH-159014) (cherry picked from commit 91248026c8a41910098032dd23f9a05ad2d9b513) Co-authored-by: Abhishek Acharya <118182738+abhishekacharya200@users.noreply.github.com> --- Doc/howto/remote_debugging.rst | 4 ++-- Doc/using/cmdline.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Doc/howto/remote_debugging.rst b/Doc/howto/remote_debugging.rst index 1a8e8593e8a60a..f5f45c399ae1ff 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 a33747830f893c..fd9605c4fc28df 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -634,7 +634,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. @@ -1244,7 +1244,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