gh-143993: Document ways to disable remote debugging support#143994
gh-143993: Document ways to disable remote debugging support#143994vstinner merged 8 commits intopython:mainfrom
Conversation
Although PEP 768 mentions how to disable the mechanism of remote debugging, it is not documented in the Python docs. This change adds a note on how to disable remote debugging support in a Python interpreter to the remote debugging how-to and to the sys.remote_exec docs.
In remote_rebugging.rst Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
in sys.rst Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
|
Thanks for the PR! It's a good idea to document these three methods together. @pablogsal What do you think about the placement and prominence of these?
Maybe they don't need to be highlighted in a note admonition and could be regular text? In the HOWTO, it could perhaps to its own section with a header, which will make it easier to share. In the |
Doc/howto/remote_debugging.rst
Outdated
|
|
||
| Most platforms require elevated privileges to attach to another Python process. | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
This probably deserves its own little section that appears in the sidebar :)
Doc/howto/remote_debugging.rst
Outdated
| To disable remote debugging support, use any of the following: | ||
|
|
||
| * Set the :envvar:`PYTHON_DISABLE_REMOTE_DEBUG` environment variable to | ||
| any value before starting the interpreter. |
There was a problem hiding this comment.
I would prefer suggesting a specific value such as 1.
| local and remote interpreters must be the same exact version. | ||
|
|
There was a problem hiding this comment.
What do you think about adding a reference to the HOWTO here? For example:
See also :ref:`remote-debugging` for information about the remote debugging protocol.
I think the one in |
Instead of duplicating the info about disabling remote debugging.
Similar to how it's done for other methods introduced in PEPs.
I replaced the note about how to disable remote debugging in |
…ythonGH-143994) Although PEP 768 mentions how to disable the mechanism of remote debugging, it is not documented in the Python docs. This change adds a note on how to disable remote debugging support in a Python interpreter to the remote debugging how-to. (cherry picked from commit 0b5f835) Co-authored-by: Rafael Weingartner-Ortner <38643099+RafaelWO@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
|
GH-144139 is a backport of this pull request to the 3.14 branch. |
|
Merged, thanks. |
…H-143994) (#144139) gh-143993: Document ways to disable remote debugging support (GH-143994) Although PEP 768 mentions how to disable the mechanism of remote debugging, it is not documented in the Python docs. This change adds a note on how to disable remote debugging support in a Python interpreter to the remote debugging how-to. (cherry picked from commit 0b5f835) Co-authored-by: Rafael Weingartner-Ortner <38643099+RafaelWO@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
5 participants
Although PEP 768 mentions how to disable the mechanism of remote debugging, it is not documented in the Python docs.
This change adds a note on how to disable remote debugging support in a Python interpreter to the remote debugging how-to and to the
sys.remote_execdocs.📚 Documentation preview 📚: