This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [doc patch] gdbserver.1: Document all the options and --multi
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Jan Kratochvil <jan dot kratochvil at redhat dot com>
- Cc: gdb-patches at sourceware dot org
- Date: Fri, 05 Apr 2013 21:40:08 +0300
- Subject: Re: [doc patch] gdbserver.1: Document all the options and --multi
- References: <20130405181316 dot GA3675 at host2 dot jankratochvil dot net>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> Date: Fri, 5 Apr 2013 20:13:16 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
>
> patch is dependent on the pending patch:
> Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1
> http://sourceware.org/ml/gdb-patches/2013-04/msg00120.html
> Message-ID: <20130405150101.GA15883@host2.jankratochvil.net>
>
> gdbserver man page was missing various parts.
>
> The text I usually took from their existing gdb.texinfo description although
> I tried to make them more brief for the man page.
Thanks.
> That is @code{gdb TARGET-PROG}, or @code{gdb --baud BAUD TARGET-PROG}. After that, the only
> -new command you need to know about is @code{target remote}. It's argument is either
> +new command you need to know about is @code{target remote}
> +(or @code{target extended-remote}. It's argument is either
^ ^^^^
First, that left parenthesis doesn't seem to have a matching right
one. Also, you want "Its", not "It's".
> +The three mode of executing @command{gdbserver} has the following three modes
> +of execution.
Hmmm... one of the "three modes" here should be removed, I think.
> +The @var{comm} parameter always specifies how to communicate with @value{GDBN},
> +users typically use local TCP port 1234 specified as a @code{:1234} string.
This should probably moved after the @table which describes the 3
modes, otherwise it gets in the way of the flow. Also, you can remove
the identical text at the beginning of each mode sdescription:
> +You have to supply how to communicate with @value{GDBN} (typically local TCP
> +port @code{:1234})
It is enough to describe everything except the 'comm' parameter.
> +In each of the modes one may specify these options:
^^^
It was "you" before; let's be consistent.
> +@item --debug
> +Enable @code{gdbserver} to display extra status information about the debugging
> +process.
"Enable ... to display" is not right. How about "Instruct" instead.
> +@item --remote-debug
> +Enable @code{gdbserver} to display remote protocol debug output.
Likewise here.