Skip to content

Commit

Permalink
Doc cleanups (#22)
Browse files Browse the repository at this point in the history
* 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..
  • Loading branch information
rocky authored Jun 17, 2024
1 parent 30edf60 commit 8314f4f
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 13 deletions.
4 changes: 2 additions & 2 deletions command/skip.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions command/step.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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:
---------
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/running/continue.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index:: continue
.. _continue:

Continue Program Execution (`continue`)
Continue Program Execution (``continue``)
---------------------------------------

**continue** [ *loc* | **-*** ]
Expand Down
9 changes: 5 additions & 4 deletions docs/commands/running/quit.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -13,4 +12,6 @@ of those shells should have been run under the debugger.

.. seealso::

:ref:`kill <kill>` or `kill` for more forceful termination commands. :ref:`run <run>` restarts the debugged program.

:ref:`kill <kill>` for more forceful termination commands. :ref:`run <run>` restarts the debugged program.

4 changes: 2 additions & 2 deletions docs/commands/running/run.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. index:: run
.. _run:

Restart Program (`run`)
-----------------------
Restart Program (``run``)
-------------------------

**run** [*args*]

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/running/step.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
+++++++++
Expand Down

0 comments on commit 8314f4f

Please sign in to comment.