[remote protocol] [doc] PATCH: document remote protocol extensions to support non-stop mode
Eli Zaretskii
eliz@gnu.org
Wed Aug 13 18:52:00 GMT 2008
> Date: Wed, 13 Aug 2008 12:42:54 -0400
> From: Sandra Loosemore <sandra@codesourcery.com>
> CC: Pedro Alves <pedro@codesourcery.com>
>
> Here is the patch I put together to document the remote protocol extensions to
> implement non-stop mode.
Thanks!
> ! All @value{GDBN} commands and responses (other than acknowledgments
> ! and notifications, @pxref{Notification Packets}) are sent as a
This usage of @pxref is only marginally right.
> ! threads in all attached processes. This is the default all-stop mode
> ! behavior, but the remote protocol also supports @value{GDBN}'s non-stop
> ! execution mode; @pxref{Remote Non-Stop}, for details.
And this one is definitely wrong.
> ! step and continue. This packet has a special interpretation when the
> ! target is in non-stop mode; @pxref{Remote Non-Stop}.
As is this one.
I'd use "see @ref" in all 3 cases.
> @item vAttach;@var{pid}
> @cindex @samp{vAttach} packet
> Attach to a new process with the specified process ID. @var{pid} is a
> ! hexadecimal integer identifying the process.
The second sentence will begin with a lower-case letter, which is not
correct English. I suggest to rephrase as follows:
Attach to a new process with the specified process ID @var{pid}.
The process ID is a hexadecimal integer identifying the process.
> + @item T @var{sig}
> + Stop with signal @var{sig}. @var{sig} should be two hex digits.
Suggest a similar rephrasing here.
> ! The optional @var{addr} argument normally associated with the
"The optional argument @var{addr}" is better, I think.
> ! @node Notification Packets
> ! @section Notification Packets
> ! @cindex notification packets
> ! @cindex packets, notification
> ! @cindex notifications
Having the 1st and the 3rd @cindex entries on the same page is not
useful. Do we really need the 3rd one? what does it add?
Otherwise, OK. Thanks.
More information about the Gdb-patches
mailing list