Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Jan Kratochvil <jan.kratochvil@redhat.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [doc patch] gdbserver.1: Document all the options and --multi
Date: Fri, 05 Apr 2013 20:01:00 -0000	[thread overview]
Message-ID: <83ppy8es8n.fsf@gnu.org> (raw)
In-Reply-To: <20130405181316.GA3675@host2.jankratochvil.net>

> 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.


  reply	other threads:[~2013-04-05 18:40 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-05 19:33 Jan Kratochvil
2013-04-05 20:01 ` Eli Zaretskii [this message]
2013-04-06  9:31   ` Jan Kratochvil
2013-04-06 13:56     ` Eli Zaretskii
2013-04-06 15:04       ` Jan Kratochvil
2013-04-06 15:49         ` Eli Zaretskii
2013-04-06 15:52           ` [commit] " Jan Kratochvil
2013-04-06 19:26             ` Eli Zaretskii
2013-04-06 21:45               ` Jan Kratochvil
2013-04-07  6:21                 ` [commit#2] " Jan Kratochvil

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83ppy8es8n.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=jan.kratochvil@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox