This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH 2/4] gdbserver: Add debug-file option
> From: Alan Hayward <Alan.Hayward@arm.com>
> CC: nd <nd@arm.com>, Alan Hayward <Alan.Hayward@arm.com>
> Date: Tue, 16 Apr 2019 10:17:41 +0000
>
> gdb/doc/ChangeLog:
>
> 2019-04-16 Alan Hayward <alan.hayward@arm.com>
>
> * gdb.texinfo
> (Other Command-Line Arguments for gdbserver): Add debug-file
The node name in parentheses should be on the same line as
gdb.texinfo.
> (Monitor Commands for gdbserver): Likewise.
> (gdbserver man): Likewise.
It is better to have a list of node names in parentheses, with only
one description, than having separate entries that say "Likewise".
> +@cindex @option{--debug-file}, @code{gdbserver} option
I think it would be good to have here an additional index entry:
@cindex @code{gdbserver}, send all debug output to a single file
> +The @option{--debug-file=filename} option tells @code{gdbserver} to
^^^^^^^^
"filename" should be in @var here, as it is a parameter.
> +write any debug output to the given file. These options are intended
^^^^^^^^^^^^^^^^^
"to the given @var{filename}", so as to reference the parameter.
> +@item --debug-file=filename
> +Instruct @code{gdbserver} to send any debug output to the given file.
Same here.
The documentation changes are okay with these nits fixed.
Thanks.