RFA: GDB manual: consolidate reserved packet descriptions

RFA: GDB manual: consolidate reserved packet descriptions

[Jim Blandy]

[-- Attachment #1: Type: text/plain, Size: 283 bytes --]

This came out of some recent discussion on gdb@.

gdb/doc/ChangeLog:
2005-11-15  Jim Blandy  <jimb@redhat.com>

	* gdb.texinfo (Packets): Mention that packets beginning with
	letters are reserved once, at the top, instead of actually listing
	them all and saying "reserved".

[-- Attachment #2: jimb.gdb-doc-remote-protocol-reserved.patch --]
[-- Type: text/x-patch, Size: 4626 bytes --]

gdb/doc/ChangeLog:
2005-11-15  Jim Blandy  <jimb@redhat.com>

	* gdb.texinfo (Packets): Mention that packets beginning with
	letters are reserved once, at the top, instead of actually listing
	them all and saying "reserved".

Index: gdb/doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.287
diff -c -p -r1.287 gdb.texinfo
*** gdb/doc/gdb.texinfo	14 Nov 2005 03:27:22 -0000	1.287
--- gdb/doc/gdb.texinfo	15 Nov 2005 08:49:19 -0000
*************** The following table provides a complete 
*** 22113,22118 ****
--- 22113,22121 ----
  @xref{File-I/O remote protocol extension}, for details about the File
  I/O extension of the remote protocol.
  
+ Note that all packet forms beginning with an upper- or lower-case
+ letter, other than those described here, are reserved for future use.
+ 
  @table @r
  
  @item @code{!} --- extended mode
*************** step and continue.
*** 22137,22146 ****
  Reply:
  @xref{Stop Reply Packets}, for the reply specifications.
  
- @item @code{a} --- reserved
- 
- Reserved for future use.
- 
  @item @code{A}@var{arglen}@code{,}@var{argnum}@code{,}@var{arg}@code{,@dots{}} ---  set program arguments @strong{(reserved)}
  @cindex @code{A} packet
  
--- 22140,22145 ----
*************** for success
*** 22215,22232 ****
  for an error
  @end table
  
- @item @code{e} --- reserved
- 
- Reserved for future use.
- 
- @item @code{E} --- reserved
- 
- Reserved for future use.
- 
- @item @code{f} --- reserved
- 
- Reserved for future use.
- 
  @item @code{F}@var{RC}@code{,}@var{EE}@code{,}@var{CF}@code{;}@var{XX} --- Reply to target's F packet.
  @cindex @code{F} packet
  
--- 22214,22219 ----
*************** for success
*** 22267,22276 ****
  for an error
  @end table
  
- @item @code{h} --- reserved
- 
- Reserved for future use.
- 
  @item @code{H}@var{c}@var{t@dots{}} --- set thread
  @cindex @code{H} packet
  
--- 22254,22259 ----
*************** step starting at that address.
*** 22316,22329 ****
  
  @xref{step with signal packet}.  @xref{cycle step packet}.
  
- @item @code{j} --- reserved
- 
- Reserved for future use.
- 
- @item @code{J} --- reserved
- 
- Reserved for future use.
- 
  @item @code{k} --- kill request
  @cindex @code{k} packet
  
--- 22299,22304 ----
*************** FIXME: @emph{There is no description of 
*** 22331,22348 ****
  thread context has been selected (i.e.@: does 'k' kill only that
  thread?)}.
  
- @item @code{K} --- reserved
- 
- Reserved for future use.
- 
- @item @code{l} --- reserved
- 
- Reserved for future use.
- 
- @item @code{L} --- reserved
- 
- Reserved for future use.
- 
  @item @code{m}@var{addr}@code{,}@var{length} --- read memory
  @cindex @code{m} packet
  
--- 22306,22311 ----
*************** for an error (this includes the case whe
*** 22378,22397 ****
  written).
  @end table
  
- @item @code{n} --- reserved
- 
- Reserved for future use.
- 
- @item @code{N} --- reserved
- 
- Reserved for future use.
- 
- @item @code{o} --- reserved
- 
- Reserved for future use.
- 
- @item @code{O} --- reserved
- 
  @item @code{p}@var{hex number of register} --- read register packet
  @cindex @code{p} packet
  
--- 22341,22346 ----
*************** thread is still alive
*** 22505,22518 ****
  thread is dead
  @end table
  
- @item @code{u} --- reserved
- 
- Reserved for future use.
- 
- @item @code{U} --- reserved
- 
- Reserved for future use.
- 
  @item @code{v} --- verbose packet prefix
  
  Packets starting with @code{v} are identified by a multi-letter name,
--- 22454,22459 ----
*************** command in the @code{vCont} packet.
*** 22559,22580 ****
  The @code{vCont} packet is not supported.
  @end table
  
- @item @code{V} --- reserved
- 
- Reserved for future use.
- 
- @item @code{w} --- reserved
- 
- Reserved for future use.
- 
- @item @code{W} --- reserved
- 
- Reserved for future use.
- 
- @item @code{x} --- reserved
- 
- Reserved for future use.
- 
  @item @code{X}@var{addr}@code{,}@var{length}@var{:}@var{XX@dots{}} --- write mem (binary)
  @cindex @code{X} packet
  
--- 22500,22505 ----
*************** for success
*** 22591,22604 ****
  for an error
  @end table
  
- @item @code{y} --- reserved
- 
- Reserved for future use.
- 
- @item @code{Y} reserved
- 
- Reserved for future use.
- 
  @item @code{z}@var{type}@code{,}@var{addr}@code{,}@var{length} --- remove breakpoint or watchpoint @strong{(draft)}
  @itemx @code{Z}@var{type}@code{,}@var{addr}@code{,}@var{length} --- insert breakpoint or watchpoint @strong{(draft)}
  @anchor{insert breakpoint or watchpoint packet}
--- 22516,22521 ----

Re: RFA: GDB manual: consolidate reserved packet descriptions

[Eli Zaretskii]

> Date: Tue, 15 Nov 2005 00:51:59 -0800
> From: Jim Blandy <jimb@red-bean.com>
> 
> This came out of some recent discussion on gdb@.
> 
> gdb/doc/ChangeLog:
> 2005-11-15  Jim Blandy  <jimb@redhat.com>
> 
> 	* gdb.texinfo (Packets): Mention that packets beginning with
> 	letters are reserved once, at the top, instead of actually listing
> 	them all and saying "reserved".

Fine with me, thanks.

Re: RFA: GDB manual: consolidate reserved packet descriptions

[Jim Blandy]

On 11/15/05, Eli Zaretskii <eliz@gnu.org> wrote:
> > From: Jim Blandy <jimb@red-bean.com>
> > gdb/doc/ChangeLog:
> > 2005-11-15  Jim Blandy  <jimb@redhat.com>
> >
> >       * gdb.texinfo (Packets): Mention that packets beginning with
> >       letters are reserved once, at the top, instead of actually listing
> >       them all and saying "reserved".
>
> Fine with me, thanks.

Committed --- thanks.