Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Kevin Buettner <kevinb@redhat.com>
Cc: gdb-patches@sources.redhat.com
Subject: Re: [rfa/doc] Add section on interrupts to remote protocol documentation
Date: Fri, 18 Nov 2005 14:06:00 -0000	[thread overview]
Message-ID: <uwtj63wxm.fsf@gnu.org> (raw)
In-Reply-To: <20051117195224.32094bd5@ironwood.lan> (message from Kevin Buettner on Thu, 17 Nov 2005 19:52:24 -0700)

> Date: Thu, 17 Nov 2005 19:52:24 -0700
> From: Kevin Buettner <kevinb@redhat.com>
> 
> The patch below adds a new section about interrupts to the remote protocol
> documentation.  A discussion on gdb@ may be found starting here:
> 
>     http://sources.redhat.com/ml/gdb/2005-11/msg00347.html
> 
> Okay?

Thanks.  This is approved, but please fix the following minor gotchas
before committing:

> +When a program on the remote target is running, @value{GDBN} may
> +attempt to interrupt it by sending a @samp{Ctrl-C} or a @code{BREAK},
> +control of which is specified via @value{GDBN}'s @samp{remotebreak}
> +setting.  @xref{set remotebreak}.

It is better to use @pxref here, like this:

  control of which is specified via @value{GDBN}'s @samp{remotebreak}
  setting (@pxref{set remotebreak}).

> +@code{0x03}.  @samp{Ctrl-C} must not be sent as part of a packet as
> +defined in the Overview section.  @xref{Overview}.

Same here: use @pxref.

> +running program, it is expected that it will send one of the Stop
> +Reply Packets (@xref{Stop Reply Packets}) to @value{GDBN} as a result

@pxref is precisely the markup for the situations when you want a
cross-reference in parentheses.  @pxref does 2 things that are
appropriate in parens: (1) it produces a phrase that begins with a
lower-case letter, since this is not a beginning of a sentence; and
(2) it doesn't require a period or a command after the closing brace,
like @xref does.  So please replace the above @xref with @pxref.

Also, I'd like us to have an index entry pointing to this section.
Could you please add one?


  parent reply	other threads:[~2005-11-18 13:30 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-11-18  5:59 Kevin Buettner
2005-11-18  8:35 ` Jim Blandy
2005-11-18 11:20   ` Steven Johnson
2005-11-18 11:57     ` Jim Blandy
2005-11-18 17:23       ` Kevin Buettner
2005-11-18 20:25         ` Jim Blandy
2005-11-18 13:53     ` Eli Zaretskii
2005-11-18 15:33       ` Steven Johnson
2005-11-18 14:06 ` Eli Zaretskii [this message]
2005-11-18 21:45   ` Kevin Buettner
2005-11-18 21:47     ` Daniel Jacobowitz
2005-11-18 22:07     ` Jim Blandy
2005-11-19 10:57       ` Steven Johnson
2005-11-18 22:18     ` Kevin Buettner
2005-11-18 22:19     ` Michael Snyder
2005-11-18 22:38     ` Eli Zaretskii
2005-11-19  1:21     ` Kevin Buettner

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=uwtj63wxm.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sources.redhat.com \
    --cc=kevinb@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