diff options
Diffstat (limited to 'gdb/doc/guile.texi')
| -rw-r--r-- | gdb/doc/guile.texi | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi index c6808ef..fcedef0 100644 --- a/gdb/doc/guile.texi +++ b/gdb/doc/guile.texi @@ -5,7 +5,7 @@ @c Invariant Sections being ``Free Software'' and ``Free Software Needs @c Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,'' @c and with the Back-Cover Texts as in (a) below. -@c +@c @c (a) The FSF's Back-Cover Text is: ``You are free to copy and modify @c this GNU Manual. Buying copies from GNU Press supports the FSF in @c developing GNU and promoting software freedom.'' @@ -1772,6 +1772,16 @@ invoking it interactively. If this function throws an exception, it is turned into a @value{GDBN} @code{error} call. Otherwise, the return value is ignored. +For non-prefix commands, @var{invoke} is required. For prefix +commands @var{invoke} is optional. Only prefix commands that need to +handle unknown sub-commands should supply @var{invoke}. + +For prefix commands that don't supply @var{invoke}, if the prefix +command is used without a sub-command name then @value{GDBN} will +display the help text for every sub-command, unless the prefix command +is a @kbd{show} sub-command, in which case @value{GDBN} will list the +values of all sub-commands. + The argument @var{command-class} is one of the @samp{COMMAND_} constants defined below. This argument tells @value{GDBN} how to categorize the new command in the help system. The default is @code{COMMAND_NONE}. @@ -1826,7 +1836,7 @@ $1 = ("1" "2 \"3" "4 \"5" "6 '7") @deffn {Scheme Procedure} throw-user-error message . args Throw a @code{gdb:user-error} exception. -The argument @var{message} is the error message as a format string, like the +The argument @var{message} is the error message as a format string, like the @var{fmt} argument to the @code{format} Scheme function. @xref{Formatted Output,,, guile, GNU Guile Reference Manual}. The argument @var{args} is a list of the optional arguments of @var{message}. @@ -2098,8 +2108,10 @@ is the @code{<gdb:parameter>} object representing the parameter, and This function must return a string, and will be displayed to the user. @value{GDBN} will add a trailing newline. -The argument @var{doc} is the help text for the new parameter. -If there is no documentation string, a default value is used. +The argument @var{doc} is the help text for the new parameter. If +there is no documentation string, a default value is used. If the +documentation string is empty, then @value{GDBN} will print just the +@var{set-doc} and @var{show-doc} strings (see below). The argument @var{set-doc} is the help text for this parameter's @code{set} command. @@ -2425,7 +2437,7 @@ The previous frame's analyzer returns an invalid result. This frame is the outermost. @item FRAME_UNWIND_UNAVAILABLE -Cannot unwind further, because that would require knowing the +Cannot unwind further, because that would require knowing the values of registers or memory that have not been collected. @item FRAME_UNWIND_INNER_ID @@ -3899,6 +3911,9 @@ Return string to change terminal's color to this. If @var{is_foreground} is @code{#t}, then the returned sequence will change foreground color. Otherwise, the returned sequence will change background color. + +If styling is currently disabled (@pxref{Output Styling,,@kbd{set style +enabled}}), then this procedure will return an empty string. @end deffn When color is initialized, its color space must be specified. The |