Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abhishekacharya200 wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Doc/howto/remote_debugging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions Doc/using/cmdline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -1313,7 +1313,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

Expand Down
Loading