Go over docs, yet again.

Author: rocky

command/eval.sh

@@ -1,7 +1,7 @@
 # -*- shell-script -*-
 # Eval and Print commands.
 #
-#   Copyright (C) 2008, 2010-2011, 2014-2015, 2017 Rocky Bernstein
+#   Copyright (C) 2008, 2010-2011, 2014-2015, 2017, 2019 Rocky Bernstein
 #   <[email protected]>
 #
 #   This program is free software; you can redistribute it and/or
@@ -62,7 +62,7 @@ given, the following translations occur:
 See also:
 ---------
 
-**set autoeval**, **print** and **examine**.'
+**set autoeval** and **examine**.'
 
 typeset -i _Dbg_show_eval_rc; _Dbg_show_eval_rc=1
 

command/examine.sh

@@ -1,7 +1,7 @@
 # -*- shell-script -*-
 # "Examine" debugger command.
 #
-#   Copyright (C) 2008, 2010-2011, 2016
+#   Copyright (C) 2008, 2010-2011, 2016, 2019
 #   Rocky Bernstein <[email protected]>
 #
 #   This program is free software; you can redistribute it and/or
@@ -26,18 +26,27 @@ if [[ 0 == ${#funcfiletrace[@]} ]] ; then
 fi
 
 _Dbg_help_add 'examine' \
-"**examine** *expr*
+'**examine** *expr*
 
-Print value of an expression via typeset, let, and failing these, eval.
+Print value of an expression via `typeset`, `let`, and failing these, `eval`.
 
 Single variables and arithmetic expressions do not need leading $ for
 their value is to be substituted. However if neither these, variables
 need $ to have their value substituted.
 
+In contrast to normal zsh expressions, expressions should not have
+blanks which would cause zsh to see them as different tokens.
+
+Examples:
+---------
+
+    examine x+1   # ok
+    examine x + 1 # not ok
+
 See also:
 ---------
 
-**eval** and **pr**."
+**eval**.'
 
 function _Dbg_do_examine {
   typeset _Dbg_expr; _Dbg_expr=${@:-"$_Dbg_last_x_args"}

command/kill.sh

@@ -1,7 +1,8 @@
 # -*- shell-script -*-
 # gdb-like "kill" debugger command
 #
-#   Copyright (C) 2002-2006, 2008-2011, 2016 Rocky Bernstein <[email protected]>
+#   Copyright (C) 2002-2006, 2008-2011, 2016-2019 Rocky Bernstein
+#   <[email protected]>
 #
 #   This program is free software; you can redistribute it and/or
 #   modify it under the terms of the GNU General Public License as
@@ -19,15 +20,16 @@
 #   MA 02111 USA.
 
 _Dbg_help_add kill \
-"**kill** [*signal-number*]
+'**kill** [*signal-number*]
 
-Send this process a POSIX signal ('9' for 'SIGKILL' or 'kill -SIGKILL')
+Send this process a POSIX signal ("9" for "SIGKILL" or "kill -SIGKILL")
 
-9 is a non-maskable interrupt that terminates the program. If program is threaded it may
-be expedient to use this command to terminate the program.
+9 is a non-maskable interrupt that terminates the program. If program
+is threaded it may be expedient to use this command to terminate the
+program.
 
-However other signals, such as those that allow for the debugged to handle them can be
-sent.
+However other signals, such 15 or `-INT` which allow for the debugged program to
+run an interrupt handler can be sent too.
 
 Giving a negative number is the same as using its positive value.
 
@@ -38,13 +40,16 @@ Examples:
     kill 9              # same as above
     kill -9             # same as above
     kill 15             # nicer, maskable TERM signal
-    kill! 15            # same as above, but no confirmation
+    kill -INT           # same as above
+    kill -SIGINT        # same as above
+    kill -WINCH         # send "window change" signal
+    kill -USR1          # send "user 1" signal
 
 See also:
 ---------
 
 **quit** for less a forceful termination command.
-**run** is a way to restart the debugged program."
+**run** is a way to restart the debugged program.'
 
 _Dbg_do_kill() {
     if (($# > 1)); then

command/quit.sh

@@ -1,7 +1,8 @@
 # -*- shell-script -*-
 # quit.sh - gdb-like "quit" debugger command
 #
-#   Copyright (C) 2008, 2010-2011, 2014, 2018 Rocky Bernstein <[email protected]>
+#   Copyright (C) 2008, 2010-2011, 2014, 2018-2019 Rocky Bernstein
+#   <[email protected]>
 #
 #   This program is free software; you can redistribute it and/or
 #   modify it under the terms of the GNU General Public License as
@@ -21,7 +22,7 @@
 _Dbg_help_add quit \
 '**quit** [*exit-code* [*shell-levels*]]
 
-Quit the debugger.
+Gently quit the debugger.
 
 The program being debugged is aborted.  If *exit-code* is given, then
 that will be the exit return code. If *shell-levels* is given, then up
@@ -31,7 +32,7 @@ of those shells should have been run under the debugger.
 See also:
 ---------
 
-**finish**, **return** and **run**.'
+**kill**, **run** and **restart**.'
 
 _Dbg_do_quit() {
     typeset -i return_code=${1:-$_Dbg_program_exit_code}

command/run.sh

@@ -29,7 +29,8 @@ Attempt to restart the program.
 See also:
 ---------
 
-**set args**, **kill** and **quit**'
+**kill** and **quit** for termintation commands, or
+**set args** for another way to set run arguments.'
 
 _Dbg_do_run() {
 

command/set_sub/annotate.sh

@@ -1,7 +1,8 @@
 # -*- shell-script -*-
 # "set annotate" debugger command
 #
-#   Copyright (C) 2010-2011, 2014, 2016 Rocky Bernstein <[email protected]>
+#   Copyright (C) 2010-2011, 2014, 2016, 2019 Rocky Bernstein
+#   <[email protected]>
 #
 #   This program is free software; you can redistribute it and/or
 #   modify it under the terms of the GNU General Public License as
@@ -32,10 +33,11 @@ _Dbg_complete_level_2_data[set_annotate]='0 1'
 _Dbg_help_add_sub set annotate \
 '**set annotate** {**0**|**1**}
 
-Set annotation level.
+Set annotation level. This is a (mostly obsolete) gdb setting, but
+it is used in GNU Emacs.
 
   0 - normal
-  1 - fullname (for use when running under emacs).
+  1 - fullname (for use when running under GNU Emacs).
 
 See also:
 ---------

command/set_sub/args.sh

@@ -1,7 +1,7 @@
 # -*- shell-script -*-
 # "set args" debugger command
 #
-#   Copyright (C) 2010-2011, 2016 Rocky Bernstein <[email protected]>
+#   Copyright (C) 2010-2011, 2016, 2019 Rocky Bernstein <[email protected]>
 #
 #   This program is free software; you can redistribute it and/or
 #   modify it under the terms of the GNU General Public License as
@@ -22,7 +22,13 @@ _Dbg_help_add_sub set args \
 '**set** *args** *script-args*
 
 Set argument list to give program being debugged when it is started.
-Follow this command with any number of args, to be passed to the program.'
+Follow this command with any number of args, to be passed to the program.
+
+See also:
+---------
+
+**run**
+'
 
 _Dbg_do_set_args() {
     # We use the loop below rather than _Dbg_set_args="(@)" because

command/set_sub/autoeval.sh

@@ -1,7 +1,8 @@
 # -*- shell-script -*-
 # "set autoeval" debugger command
 #
-#   Copyright (C) 2011, 2014, 2016-2017 Rocky Bernstein <[email protected]>
+#   Copyright (C) 2011, 2014, 2016-2017, 2019 Rocky Bernstein
+#   <[email protected]>
 #
 #   This program is free software; you can redistribute it and/or
 #   modify it under the terms of the GNU General Public License as
@@ -35,9 +36,9 @@ _Dbg_help_add_sub set autoeval \
 Evaluate unrecognized debugger commands.
 
 Often inside the debugger, one would like to be able to run arbitrary
-Python commands without having to preface Python expressions with
+zsh commands without having to preface zsh expressions with
 ``print`` or ``eval``. Setting *autoeval* on will cause unrecognized
-debugger commands to be *eval* as a Python expression.
+debugger commands to be *eval* as a zsh expression.
 
 Note that if this is set, on error the message shown on type a bad
 debugger command changes from:

command/show_sub/annotate.sh

@@ -19,9 +19,14 @@
 #   MA 02111 USA.
 
 _Dbg_help_add_sub show annotate \
-"show annotate
+"**show annotate**
 
-Show annotation level" 1
+Show annotation level. This is a (mostly obsolete) gdb setting, but
+it is used in GNU Emacs.
+
+   0 - normal
+   1 - fullname (for use when running under emacs).
+" 1
 
 _Dbg_do_show_annotate() {
     typeset label="$1"

docs/commands/data/eval.rst

@@ -20,7 +20,7 @@ Often when one is stopped at the line of the first part of an "if", "elif", "cas
 portion. For this, use eval?. Actually, any alias that ends in ? which is aliased to eval will
 do thie same thing.
 
-Run *python-statement* in the context of the current frame.
+Run *cmd* in the context of the current frame.
 
 If no string is given, we run the string from the current source code
 about to be run. If the command ends `?` (via an alias) and no string is
@@ -49,5 +49,4 @@ Examples:
 
 .. seealso::
 
-   :ref:`set autoeval <set_autoeval>`
-   and :ref:`examine <examine>`.
+   :ref:`set autoeval <set_autoeval>` and :ref:`examine <examine>`.