mirror of
https://github.com/python/cpython.git
synced 2025-08-04 00:48:58 +00:00
[3.13] gh-130160: use .. program::
directive for documenting pdb
CLI (GH-130996) (#131014)
gh-130160: use `.. program::` directive for documenting `pdb` CLI (GH-130996)
(cherry picked from commit c240c2d88a
)
Co-authored-by: donBarbos <donbarbos@proton.me>
This commit is contained in:
parent
d50941c1c3
commit
28406cd0a1
1 changed files with 17 additions and 8 deletions
|
@ -75,10 +75,12 @@ The debugger's prompt is ``(Pdb)``, which is the indicator that you are in debug
|
|||
arguments of the ``p`` command.
|
||||
|
||||
|
||||
.. program:: pdb
|
||||
|
||||
You can also invoke :mod:`pdb` from the command line to debug other scripts. For
|
||||
example::
|
||||
|
||||
python -m pdb myscript.py
|
||||
python -m pdb [-c command] (-m module | pyfile) [args ...]
|
||||
|
||||
When invoked as a module, pdb will automatically enter post-mortem debugging if
|
||||
the program being debugged exits abnormally. After post-mortem debugging (or
|
||||
|
@ -86,14 +88,21 @@ after normal exit of the program), pdb will restart the program. Automatic
|
|||
restarting preserves pdb's state (such as breakpoints) and in most cases is more
|
||||
useful than quitting the debugger upon program's exit.
|
||||
|
||||
.. versionchanged:: 3.2
|
||||
Added the ``-c`` option to execute commands as if given
|
||||
in a :file:`.pdbrc` file; see :ref:`debugger-commands`.
|
||||
.. option:: -c, --command <command>
|
||||
|
||||
.. versionchanged:: 3.7
|
||||
Added the ``-m`` option to execute modules similar to the way
|
||||
``python -m`` does. As with a script, the debugger will pause execution just
|
||||
before the first line of the module.
|
||||
To execute commands as if given in a :file:`.pdbrc` file; see
|
||||
:ref:`debugger-commands`.
|
||||
|
||||
.. versionchanged:: 3.2
|
||||
Added the ``-c`` option.
|
||||
|
||||
.. option:: -m <module>
|
||||
|
||||
To execute modules similar to the way ``python -m`` does. As with a script,
|
||||
the debugger will pause execution just before the first line of the module.
|
||||
|
||||
.. versionchanged:: 3.7
|
||||
Added the ``-m`` option.
|
||||
|
||||
Typical usage to execute a statement under control of the debugger is::
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue