[PATCH/doc] Remove fixme of packet "k"
Commit Message
On 03/20/14 00:12, Eli Zaretskii wrote:
>> Date: Wed, 19 Mar 2014 16:02:29 +0800
>> From: Hui Zhu <hui_zhu@mentor.com>
>> CC: Eli Zaretskii <eliz@gnu.org>
>>
>> Hi Stan,
>>
>> According to your comments. I make a new patch.
>>
>> Thanks,
>> Hui
>>
>> 2014-03-19 Stan Shebs <stan@codesourcery.com>
>> Hui Zhu <hui@codesourcery.com>
>>
>> * gdb.texinfo (k packet): Remove fixme and update introduction.
>> (vKill packet): Add anchor.
>
> Thanks. But these changes are both in the node called "Packets", not
> "k packet" or "vKill packet", so please change the text in parentheses
> to name the node (just once).
>
>> +A multiple-process target may choose to kill just one process, or all
>> +that that are under GDB's control. For more precise control, use the
> ^^^^^^^^^
> One "that" is redundant.
>
>> +vKill packet.(@pxref{vKill packet})
>
> @pxref should be before the period, like this:
>
> vKill packet (@pxref{vKill packet}).
>
> OK with those changes.
>
Updated a new version according to your comments.
Please help me review it.
Thanks,
Hui
2014-03-20 Stan Shebs <stan@codesourcery.com>
Hui Zhu <hui@codesourcery.com>
* gdb.texinfo (Packets): Remove fixme and update introduction of
"k packet". Add anchor to "vKill packet".
Comments
On 03/20/2014 03:44 AM, Hui Zhu wrote:
> @item k
> @cindex @samp{k} packet
> -Kill request.
> +Kill the target process or processes.
>
> -FIXME: @emph{There is no description of how to operate when a specific
> -thread context has been selected (i.e.@: does 'k' kill only that
> -thread?)}.
> +The exact effect of this packet is not specified. For a single-process
> +target, it will kill that process if possible.
This is looking good to me too, but I'd like to suggest further
extending it some. As is I think this may leave bare metal stub
developers wondering what does "kill the single-process target"
means. I'd leave the "Kill request" title unmodified. I'd
suggest using "may" instead of "will". I think we should mention
that even not replying an ack is OK. So here's my suggestion:
@item k
@cindex @samp{k} packet
Kill request.
The exact effect of this packet is not specified.
For a bare-metal target, it may power cycle or reset the target
system. For that reason, the @samp{k} packet has no reply.
For a single-process target, it may kill that process if possible.
A multiple-process target may choose to kill just one process, or all
that are under GDB's control. For more precise control, use the vKill
packet (@pxref{vKill packet}).
If the target system immediately closes the connection in response to
@samp{k}, @value{GDBN} does not consider the lack of packet
acknowledgment to be an error, and assumes the kill was successful.
If connected using @kbd{target extended-remote}, and the target does
not close the connection in response to a kill request, @value{GDBN}
probes the target state as if a new connection was opened (pxfer to
the status/"?" packet here).
> +
> +A multiple-process target may choose to kill just one process, or all
> +that are under GDB's control. For more precise control, use the
( Should be @value{GDBN}. )
> Date: Thu, 20 Mar 2014 11:44:23 +0800
> From: Hui Zhu <hui_zhu@mentor.com>
> CC: <stanshebs@earthlink.net>, <gdb-patches@sourceware.org>
>
> Updated a new version according to your comments.
This version is OK, thanks.
> Date: Thu, 20 Mar 2014 10:49:13 +0000
> From: Pedro Alves <palves@redhat.com>
> CC: Eli Zaretskii <eliz@gnu.org>, stanshebs@earthlink.net,
> gdb-patches@sourceware.org
>
> This is looking good to me too, but I'd like to suggest further
> extending it some.
Your extensions are fine with me.
Thanks.
@@ -33952,11 +33952,16 @@ step packet}.
@item k
@cindex @samp{k} packet
-Kill request.
+Kill the target process or processes.
-FIXME: @emph{There is no description of how to operate when a specific
-thread context has been selected (i.e.@: does 'k' kill only that
-thread?)}.
+The exact effect of this packet is not specified. For a single-process
+target, it will kill that process if possible.
+
+A multiple-process target may choose to kill just one process, or all
+that are under GDB's control. For more precise control, use the
+vKill packet (@pxref{vKill packet}).
+
+The @samp{k} packet has no reply.
@item m @var{addr},@var{length}
@cindex @samp{m} packet
@@ -34258,6 +34263,7 @@ request is completed.
@item vKill;@var{pid}
@cindex @samp{vKill} packet
+@anchor{vKill packet}
Kill the process with the specified process ID. @var{pid} is a
hexadecimal integer identifying the process. This packet is used in
preference to @samp{k} when multiprocess protocol extensions are