From 8314f4f8acf406f534eea369e33bcab2d98cf6e0 Mon Sep 17 00:00:00 2001 From: "R. Bernstein" Date: Mon, 17 Jun 2024 10:01:50 -0400 Subject: [PATCH] Doc cleanups (#22) * First batch of doc cleanups * zsh{,db} -> bash{,db} and other doc fixes * zsh{,db} -> bash{,db} and other doc fixes * Gratuituous change to get readthe docs to reread? * Go over docs. Sync with zshdb.. --- command/skip.sh | 4 ++-- command/step.sh | 6 +++--- docs/commands/running/continue.rst | 2 +- docs/commands/running/quit.rst | 9 +++++---- docs/commands/running/run.rst | 4 ++-- docs/commands/running/step.rst | 2 +- 6 files changed, 14 insertions(+), 13 deletions(-) diff --git a/command/skip.sh b/command/skip.sh index 0e4b15a..63b6573 100644 --- a/command/skip.sh +++ b/command/skip.sh @@ -22,7 +22,7 @@ _Dbg_help_add skip \ "**skip** [*count*] -Skip (don't run) the next *count* command(s). +Skip over (don't run) the next *count* command(s). If *count* is given, stepping occurs that many times before stopping. Otherwise *count* is one. *count* can be an arithmetic @@ -36,7 +36,7 @@ in: echo not skipped fi -skipping the *if* statement will in effect skip running the *grep* +Skipping the *if* statement will, in effect, skip running the *grep* command. Since the return code is 0 when skipped, the *if* body is entered. Similarly the same thing can happen in a *while* statement test. diff --git a/command/step.sh b/command/step.sh index 8c703e7..fdbc431 100644 --- a/command/step.sh +++ b/command/step.sh @@ -38,13 +38,13 @@ expression. If suffix \"+\" is added, we ensure that the file and line position is different from the last one just stopped at. -However in contrast to \"next\", functions and source'd files are stepped -into. - If suffix \"-\" is added, the different line aspect of \"step+\" does not occur. With no suffix is given, the behavior is dictated by the setting of **set different**. +In contrast to \"next\", functions and source'd files are stepped +into. + Examples: --------- diff --git a/docs/commands/running/continue.rst b/docs/commands/running/continue.rst index 4bf9347..ca44523 100644 --- a/docs/commands/running/continue.rst +++ b/docs/commands/running/continue.rst @@ -1,7 +1,7 @@ .. index:: continue .. _continue: -Continue Program Execution (`continue`) +Continue Program Execution (``continue``) --------------------------------------- **continue** [ *loc* | **-*** ] diff --git a/docs/commands/running/quit.rst b/docs/commands/running/quit.rst index 555e857..1b62af4 100644 --- a/docs/commands/running/quit.rst +++ b/docs/commands/running/quit.rst @@ -1,9 +1,8 @@ .. index:: quit .. _quit: -Gentle Termination (`quit`) ---------------------------- - +Gentle Termination (``quit``) +----------------------------- **quit** [*exit-code* [*shell-levels*]] The program being debugged is aborted. If *exit-code* is given, then @@ -13,4 +12,6 @@ of those shells should have been run under the debugger. .. seealso:: - :ref:`kill ` or `kill` for more forceful termination commands. :ref:`run ` restarts the debugged program. + + :ref:`kill ` for more forceful termination commands. :ref:`run ` restarts the debugged program. + \ No newline at end of file diff --git a/docs/commands/running/run.rst b/docs/commands/running/run.rst index 45dc239..469166d 100644 --- a/docs/commands/running/run.rst +++ b/docs/commands/running/run.rst @@ -1,8 +1,8 @@ .. index:: run .. _run: -Restart Program (`run`) ------------------------ +Restart Program (``run``) +------------------------- **run** [*args*] diff --git a/docs/commands/running/step.rst b/docs/commands/running/step.rst index 60738ab..50cd857 100644 --- a/docs/commands/running/step.rst +++ b/docs/commands/running/step.rst @@ -20,7 +20,7 @@ into. If suffix \"-\" is added, the different line aspect of \"step+\" does not occur. -With no suffix is given, the behavior is dictated by the setting of **set different**. +With no suffix given, the behavior is dictated by the setting of **set different**. Examples: +++++++++