Skip to content

Commit

Permalink
[3.12] gh-130160: use .. program:: directive for documenting pdb
Browse files Browse the repository at this point in the history
…CLI (GH-130996) (#131013)

gh-130160: use `.. program::` directive for documenting `pdb` CLI (GH-130996)
(cherry picked from commit c240c2d)

Co-authored-by: donBarbos <[email protected]>
  • Loading branch information
miss-islington and donBarbos authored Mar 9, 2025
1 parent 11d550c commit 9f7f2c0
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions Doc/library/pdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,25 +75,34 @@ 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
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::

Expand Down

0 comments on commit 9f7f2c0

Please sign in to comment.