Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Jim Blandy <jimb@codesourcery.com>
To: gdb-patches@sources.redhat.com
Subject: RFA: Document conventions for terminating query/set packet names
Date: Wed, 03 May 2006 19:51:00 -0000	[thread overview]
Message-ID: <vt21wvavqe4.fsf@theseus.home.> (raw)


2006-05-03  Jim Blandy  <jimb@codesourcery.com>

	* gdb.texinfo (General Query Packets): Document conventions for
	terminating packet names, and their violations.

*** gdb.texinfo	23 Apr 2006 00:42:10 -0700	1.324
--- gdb.texinfo	03 May 2006 12:00:15 -0700	
***************
*** 23106,23114 ****
  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
  has a template showing the packet's overall syntax, followed by an
--- 23106,23115 ----
  foos) or @samp{Qacme.bar} (for setting bars).
  @end itemize
  
! The name of a query or set packet should be separated from any
! parameters by a @samp{:}; the parameters themselves should be
! separated by @samp{,} or @samp{;}.  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
  has a template showing the packet's overall syntax, followed by an
***************
*** 23252,23257 ****
--- 23253,23264 ----
  Returns information on @var{threadid}.  Where: @var{mode} is a hex
  encoded 32 bit mode; @var{threadid} is a hex encoded 64 bit thread ID.
  
+ Since this packet's name (@code{qP}) is not separated from its first
+ argument (@var{mode}) by any kind of punctuation, it is ambiguous with
+ the @code{qPart} packet.  Stubs should recognize this packet by the
+ twenty-four hex digits that follow.  New stubs should implement the
+ @code{qThreadExtraInfo} packet instead.
+ 
  Reply: see @code{remote.c:remote_unpack_thread_info_response()}.
  
  @item qPart:@var{object}:read:@var{annex}:@var{offset},@var{length}
***************
*** 23354,23359 ****
--- 23361,23371 ----
  An empty reply indicates that @samp{qRcmd} is not recognized.
  @end table
  
+ (Note that the @code{qRcmd} packet's name is separated from the
+ command by a @samp{,}, not a @samp{:}, contrary to the naming
+ conventions above.  Please don't use this packet as a model for new
+ packets.)
+ 
  @item qSymbol::
  @cindex symbol lookup, remote request
  @cindex @samp{qSymbol} packet
***************
*** 23414,23419 ****
--- 23426,23436 ----
  the thread's attributes.
  @end table
  
+ (Note that the @code{qThreadExtraInfo} packet's name is separated from
+ the command by a @samp{,}, not a @samp{:}, contrary to the naming
+ conventions above.  Please don't use this packet as a model for new
+ packets.)
+ 
  @item QTStart    
  @itemx QTStop     
  @itemx QTinit     


             reply	other threads:[~2006-05-03 19:51 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-05-03 19:51 Jim Blandy [this message]
2006-05-03 19:56 ` Daniel Jacobowitz
2006-05-03 22:54   ` Jim Blandy
2006-05-04  1:57     ` Daniel Jacobowitz
2006-05-04  6:13       ` Jim Blandy
2006-05-04 12:38         ` Daniel Jacobowitz
2006-05-04 17:24           ` Jim Blandy
2006-05-05 10:06             ` Eli Zaretskii
2006-05-05 19:14               ` Jim Blandy
2006-05-05 19:15               ` Jim Blandy
2006-05-05 19:18               ` Jim Blandy
2006-05-05 21:49                 ` Eli Zaretskii
2006-05-05 21:59                   ` Jim Blandy
2006-05-05 22:09                     ` Eli Zaretskii
2006-05-05 16:25             ` Daniel Jacobowitz
2006-05-09 20:41               ` Daniel Jacobowitz
2006-05-09 21:16                 ` Andrew Cagney
2006-05-10  3:18                 ` Eli Zaretskii
2006-05-14 17:09                   ` Daniel Jacobowitz
2006-05-10 21:14                 ` Jim Blandy
2006-05-04 15:55 ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=vt21wvavqe4.fsf@theseus.home. \
    --to=jimb@codesourcery.com \
    --cc=gdb-patches@sources.redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox