From: Don Breazeal <donb@codesourcery.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: "gdb-patches@sourceware.org" <gdb-patches@sourceware.org>
Subject: Re: [PATCH 3/3] Target remote mode fork and exec docs
Date: Fri, 13 Nov 2015 01:13:00 -0000 [thread overview]
Message-ID: <56453917.9090801@codesourcery.com> (raw)
In-Reply-To: <83mvuji2p9.fsf@gnu.org>
On 11/12/2015 8:48 AM, Eli Zaretskii wrote:
>> From: Don Breazeal <donb@codesourcery.com>
>> Date: Wed, 11 Nov 2015 17:00:00 -0800
>>
>
>> +@table @asis
>> +
>> +@cindex remote debugging, detach and program exit
>> +@item Result of detach or program exit
>> +
>> +@strong{target remote mode:} When the debugged program exits or you
>> +detach from it, @value{GDBN} disconnects from the target. When using
>> +@code{gdbserver}, @code{gdbserver} will exit.
>> +
>> +@strong{target extended-remote mode:} When the debugged program exits or
>
> This is OK, but the fact that "target extended-remote mode:" part that
> begins a sentence doesn't start with a capital letter looks wrong.
> How about starting with @strong{With target extended-remote mode:}
> instead?
>> +@item The @code{run} command
>> +@strong{target remote mode:} The @code{run} command is not supported.
>
> Please be consistent regarding whether or not you leave an empty line
> after the @item line. (My suggestion is not to leave such a line in a
> @table.)
Items above are now done in my sandbox.
>
>> If you're using a serial line, you may want to give @value{GDBN} the
>> @samp{--baud} option, or use the @code{set serial baud} command
>> (@pxref{Remote Configuration, set serial baud}) before the
>> -@code{target} command.
>> +@kbd{target} command.
>
> Here you show 2 commands in the same sentence, one with @code, the
> other with @kbd. I think both should use @code.
>
>> +In @code{target extended-remote} mode, you can also attach using the
>> +@value{GDBN} attach command
>> +(@pxref{Types of Remote Connections: Attaching}).
>
> I don't understand this @pxref -- there's no such node or anchor in
> the text. Does this work for you? (Also, using a colon in
> cross-reference or node names is a bad idea, as that confuses Info
> readers.)
These last two I had fixed in my sandbox but apparently the fixes didn't
make it into the patch I posted, sorry about that. :-S
Regarding the @pxrefs that had colons in them, I have a question. I was
making a cross-reference into the middle of a section, so
there is no section heading to use as the name of the reference. I was
trying to refer to "The part about Attaching that is in the section
'Types of Remote Connections'". How about:
@anchor{Attaching in Types of Remote Connections}
>
> The patch is approved, assuming the above minor issues are fixed.
>
> Thanks.
>
Thanks again for the review and the suggestions.
--Don
next prev parent reply other threads:[~2015-11-13 1:13 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-11-06 23:56 [PATCH 0/3] Target remote mode fork and exec support Don Breazeal
2015-11-06 23:57 ` [PATCH 2/3] Target remote mode fork and exec tests Don Breazeal
2015-11-06 23:57 ` [PATCH 1/3] Target remote mode fork and exec events Don Breazeal
2015-11-20 13:04 ` Pedro Alves
2015-11-20 16:50 ` Don Breazeal
2015-12-07 22:14 ` [PATCH v2 0/3] Target remote mode fork and exec support Don Breazeal
2015-12-07 22:14 ` [PATCH v2 2/3] Target remote mode fork and exec events Don Breazeal
2015-12-08 12:55 ` Pedro Alves
2015-12-14 19:29 ` Don Breazeal
2015-12-15 10:52 ` Pedro Alves
2015-12-07 22:14 ` [PATCH v2 1/3] Target remote mode fork and exec tests Don Breazeal
2015-12-08 12:58 ` Pedro Alves
2015-12-14 19:29 ` [pushed] " Don Breazeal
2015-12-07 22:15 ` [PATCH v2 3/3] Target remote mode fork and exec docs Don Breazeal
2015-12-08 13:07 ` Pedro Alves
2015-12-14 19:30 ` [pushed] " Don Breazeal
2015-12-08 13:11 ` [PATCH v2 0/3] Target remote mode fork and exec support Pedro Alves
2015-11-06 23:57 ` [PATCH 3/3] Target remote mode fork and exec docs Don Breazeal
2015-11-07 8:18 ` Eli Zaretskii
2015-11-12 1:00 ` Don Breazeal
2015-11-12 1:00 ` Don Breazeal
2015-11-12 16:48 ` Eli Zaretskii
2015-11-13 1:13 ` Don Breazeal [this message]
2015-11-13 8:16 ` Eli Zaretskii
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=56453917.9090801@codesourcery.com \
--to=donb@codesourcery.com \
--cc=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
/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