]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-130160: use `.. program::` directive for documenting `pdb` CLI (GH-130996...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 9 Mar 2025 16:18:43 +0000 (17:18 +0100)
committerGitHub <noreply@github.com>
Sun, 9 Mar 2025 16:18:43 +0000 (16:18 +0000)
gh-130160: use `.. program::` directive for documenting `pdb` CLI (GH-130996)
(cherry picked from commit c240c2d88a080fc3c68c220aa81062cf5f130ab9)

Co-authored-by: donBarbos <donbarbos@proton.me>
Doc/library/pdb.rst

index 32c41b8b2c16c3ba3b4f352b84711f6648a71431..f7f433190bde0883ccb0e22c972a361d2b1e96a2 100644 (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.
 
 
+.. 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::