RFA: GDB manual: clean up query packet documentation

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

RFA: GDB manual: clean up query packet documentation

jimb (Bugzilla)
gdb/doc/ChangeLog:
2005-11-17  Jim Blandy  <[hidden email]>

        * gdb.texinfo (Packets): Move information out of 'q' and 'Q'
        entries into the General Query Packets section.  Add a
        cross-reference to that section.
        (General Query Packets): Add introductory text.  Explain naming
        conventions, and how the end of a name is recognized.

jimb.gdb-doc-remote-protocol-query-cleanup.patch (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: RFA: GDB manual: clean up query packet documentation

Eli Zaretskii
> Date: Thu, 17 Nov 2005 17:27:45 -0800
> From: Jim Blandy <[hidden email]>
>
> gdb/doc/ChangeLog:
> 2005-11-17  Jim Blandy  <[hidden email]>
>
> * gdb.texinfo (Packets): Move information out of 'q' and 'Q'
> entries into the General Query Packets section.  Add a
> cross-reference to that section.
> (General Query Packets): Add introductory text.  Explain naming
> conventions, and how the end of a name is recognized.

Thanks, this is approved.

One question, though:

> - 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

This "Reply:" part is not in the new text.  Did you really intend to
delete it, and if so, why?
Reply | Threaded
Open this post in threaded view
|

Re: RFA: GDB manual: clean up query packet documentation

jimb (Bugzilla)
On 11/18/05, Eli Zaretskii <[hidden email]> wrote:

> One question, though:
>
> > - 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
>
> This "Reply:" part is not in the new text.  Did you really intend to
> delete it, and if so, why?

The descriptions for the individual packets give the forms of their
replies, and the fact that an empty reply means that the packet isn't
recognized applies to all packets, and is explained in the "Overview"
node.
Reply | Threaded
Open this post in threaded view
|

Re: RFA: GDB manual: clean up query packet documentation

Eli Zaretskii
> Date: Fri, 18 Nov 2005 09:33:44 -0800
> From: Jim Blandy <[hidden email]>
> Cc: [hidden email]
>
> On 11/18/05, Eli Zaretskii <[hidden email]> wrote:
> > One question, though:
> >
> > > - 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
> >
> > This "Reply:" part is not in the new text.  Did you really intend to
> > delete it, and if so, why?
>
> The descriptions for the individual packets give the forms of their
> replies, and the fact that an empty reply means that the packet isn't
> recognized applies to all packets, and is explained in the "Overview"
> node.

Okay.
Reply | Threaded
Open this post in threaded view
|

Re: RFA: GDB manual: clean up query packet documentation

jimb (Bugzilla)
In reply to this post by jimb (Bugzilla)
On 11/17/05, Jim Blandy <[hidden email]> wrote:
> gdb/doc/ChangeLog:
> 2005-11-17  Jim Blandy  <[hidden email]>
>
>         * gdb.texinfo (Packets): Move information out of 'q' and 'Q'
>         entries into the General Query Packets section.  Add a
>         cross-reference to that section.
>         (General Query Packets): Add introductory text.  Explain naming
>         conventions, and how the end of a name is recognized.

Committed, with an expanded ChangeLog entry.  Thanks.