diff mbox

[PATCH/doc] Remove fixme of packet "k"

Message ID 53294F15.4050503@mentor.com
State Superseded
Headers show

Commit Message

Hui Zhu March 19, 2014, 8:02 a.m. UTC
On 03/19/14 04:52, Stan Shebs wrote:
> On 3/14/14 12:22 AM, Hui Zhu wrote:
>
> [...]
>> So make a patch update doc of 'k' to:
>> ‘k’
>> Kill all processes.
>>
>> The ‘k’ packet has no reply.
>
> For old packets in the protocol, we need to be careful not to tweak the
> description so as to change the meaning.  In this case, the effect of
> 'k' is not precisely specified; while the current version of GDBserver
> has taken it to mean "all inferiors", that may not be true of the stub
> I shipped to a customer four years ago.
>
> As a replacement for the FIXME, I suggest something like
>
> "Kill the target process or processes."
>
> "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 that
> are under GDB's control.  For more precise control, use the vKill packet."
>
> "The ‘k’ packet has no reply."
>
> It seems like it should say something about inferiors as well, but
> I couldn't think of how to express it clearly.
>
> Stan
> stan@codesourcery.com
>

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.

Comments

Eli Zaretskii March 19, 2014, 4:12 p.m. UTC | #1
> 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.
diff mbox

Patch

--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -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 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