mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-28 11:15:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

gh-130160: use .. program:: directive for documenting pdb CLI (#130996)

Browse source
This commit is contained in:
donBarbos 2025-03-09 19:55:23 +04:00 • committed by GitHub
parent 92e5f826ac
commit c240c2d88a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Doc/library/pdb.rst
View file

@ -75,10 +75,12 @@ The debugger's prompt is ``(Pdb)``, which is the indicator that you are in debug
arguments of the ``p`` command. arguments of the ``p`` command.
.. program:: pdb
You can also invoke :mod:`pdb` from the command line to debug other scripts. For You can also invoke :mod:`pdb` from the command line to debug other scripts. For
example:: 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 When invoked as a module, pdb will automatically enter post-mortem debugging if
the program being debugged exits abnormally. After post-mortem debugging (or 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 restarting preserves pdb's state (such as breakpoints) and in most cases is more
useful than quitting the debugger upon program's exit. useful than quitting the debugger upon program's exit.
.. versionchanged:: 3.2 .. option:: -c, --command <command>
Added the ``-c`` option to execute commands as if given
in a :file:`.pdbrc` file; see :ref:`debugger-commands`.
.. versionchanged:: 3.7 To execute commands as if given in a :file:`.pdbrc` file; see
Added the ``-m`` option to execute modules similar to the way :ref:`debugger-commands`.
``python -m`` does. As with a script, the debugger will pause execution just
before the first line of the module. .. 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:: Typical usage to execute a statement under control of the debugger is::