Re: [rfa/doc] Add section on interrupts to remote protocol documentation

Eli Zaretskii
2005-11-18T13:30:54Z

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