[PATCH, doc RFA] Add guile gdb command support

Eli Zaretskii eliz@gnu.org
Thu May 22 15:40:00 GMT 2014


> From: Doug Evans <xdje42@gmail.com>
> Date: Wed, 21 May 2014 12:28:16 -0700
> 
> This patch adds gdb command support for guile.

Thanks.

> +@var{name} is the name of the command.

This will look wrong in print, because "name" is not capitalized by
TeX, just typeset in cursive typeface.  I would start with "The
@var{name} argument is ..." or some such.

> +@var{invoke} is a procedure of three arguments: @var{self}, @var{args}

Likewise here.

> +@var{completer} is either @code{#f}, one of the @samp{COMPLETE_} constants

And here.

> +@var{prefix} is a boolean flag indicating whether the new

And here.

> +@var{doc-string} is help text for the new command.

And here.

> +There is no support for multi-line commands.

What is a "multi-line command"?  Perhaps mention an example.

> +If the return value is a <gdb:iterator> object, it is iterated over to
                            ^^^^^^^^^^^^^^
@code markup here, please.

> +@item COMMAND_USER
> +The command is a general purpose command for the user, and typically
> +does not fit in one of the other categories.
> +Type @kbd{help user-defined} at the @value{GDBN} prompt to see
> +a list of commands in this category, as well as the list of gdb macros
> +(@pxref{Sequences}).

I think "help user-defined" lists commands defined by the user, in
which case the text above is inaccurate.

OK with those fixes.



More information about the Gdb-patches mailing list