* gdb.texinfo (Packets): Move information out of 'q' and 'Q'

entries into the General Query Packets section.  Add a
cross-reference to that section.  Drop description of replies, as
these are covered in the descriptions of each packet.
(General Query Packets): Add introductory text.  Explain naming
conventions, and how the end of a name is recognized.
This commit is contained in:
Jim Blandy 2005-11-18 19:20:56 +00:00
parent 0be75e0273
commit 5f3bebba9f
2 changed files with 42 additions and 23 deletions

View File

@ -1,3 +1,12 @@
2005-11-18 Jim Blandy <jimb@redhat.com>
* gdb.texinfo (Packets): Move information out of 'q' and 'Q'
entries into the General Query Packets section. Add a
cross-reference to that section. Drop description of replies, as
these are covered in the descriptions of each packet.
(General Query Packets): Add introductory text. Explain naming
conventions, and how the end of a name is recognized.
2005-11-17 Kevin Buettner <kevinb@redhat.com> 2005-11-17 Kevin Buettner <kevinb@redhat.com>
* gdb.texinfo (Remote configuration): Fix typo in description of * gdb.texinfo (Remote configuration): Fix typo in description of

View File

@ -22397,30 +22397,12 @@ for success
for an error for an error
@end table @end table
@item q @var{query} @item q @var{name} @var{params}@dots{}
@anchor{general query packet} @itemx Q @var{name} @var{params}@dots{}
@cindex @samp{q} packet @cindex @samp{q} packet
General query. Request info about @var{query}. In general
@value{GDBN} queries have a leading upper case letter. Custom vendor
queries should use a company prefix (in lower case) ex:
@samp{qfsf.var}. @var{query} may optionally be followed by a @samp{,}
or @samp{;} separated list. Stubs must ensure that they match the
full @var{query} name.
Reply:
@table @samp
@item @var{XX@dots{}}
Hex encoded data from query. The reply must not be empty.
@item E @var{NN}
error reply
@item
Indicating an unrecognized @var{query}.
@end table
@item Q @var{var}=@var{val}
@cindex @samp{Q} packet @cindex @samp{Q} packet
General set. Set value of @var{var} to @var{val}. General query (@samp{q}) and set (@samp{Q}). These packets are
@xref{general query packet}, for a discussion of naming conventions. described fully in @ref{General Query Packets}.
@item r @item r
@cindex @samp{r} packet @cindex @samp{r} packet
@ -22735,7 +22717,33 @@ protocol extension}, for more details.
@section General Query Packets @section General Query Packets
@cindex remote query requests @cindex remote query requests
The following set and query packets have already been defined. Packets starting with @samp{q} are @dfn{general query packets};
packets starting with @samp{Q} are @dfn{general set packets}. General
query and set packets are a semi-unified form for retrieving and
sending information to and from the stub.
The initial letter of a query or set packet is followed by a name
indicating what sort of thing the packet applies to. For example,
@value{GDBN} may use a @samp{qSymbol} packet to exchange symbol
definitions with the stub. These packet names follow some
conventions:
@itemize @bullet
@item
The name must not contain commas, colons or semicolons.
@item
Most @value{GDBN} query and set packets have a leading upper case
letter.
@item
The names of custom vendor packets should use a company prefix, in
lower case, followed by a period. For example, packets designed at
the Acme Corporation might begin with @samp{qacme.foo} (for querying
foos) or @samp{Qacme.bar} (for setting bars).
@end itemize
A query or set packet may optionally be followed by a @samp{,} or
@samp{;} separated list. Stubs must be careful to match the full
packet name, in case packet names have common prefixes.
Like the descriptions of the other packets, each description here Like the descriptions of the other packets, each description here
has a template showing the packet's overall syntax, followed by an has a template showing the packet's overall syntax, followed by an
@ -22743,6 +22751,8 @@ explanation of the packet's meaning. We include spaces in some of the
templates for clarity; these are not part of the packet's syntax. No templates for clarity; these are not part of the packet's syntax. No
@value{GDBN} packet uses spaces to separate its components. @value{GDBN} packet uses spaces to separate its components.
Here are the currently defined query and set packets:
@table @samp @table @samp
@item qC @item qC