This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: RFA: Document conventions for terminating query/set packet names


Eli Zaretskii <eliz@gnu.org> writes:
>> Date: Thu, 4 May 2006 10:24:22 -0700
>> From: "Jim Blandy" <jimb@red-bean.com>
>> 
>> Here's a revised patch:
>> 
>> 2006-05-04  Jim Blandy  <jimb@codesourcery.com>
>> 
>> 	* gdb.texinfo (General Query Packets): Document conventions for
>> 	terminating packet names, and their violations.
>
> Fine with me, but...
>
>> ! 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.  The
>> ! @code{qP} and @code{qL} packets predate these conventions; since we
>> ! suspect they are in widespread use in places that are difficult to
>> ! upgrade, new packets should not begin with @code{qP} or @code{qL}.
>
> ...perhaps the last sentence will be better placed in a footnote.
> WDYT?

(Argh.  In Emacs, the command to insert '@code{}' in a texinfo-mode
buffer is C-c C-c c.  But in a mail-mode buffer, C-c C-c is 'send
message'...)

We could replace that last sentence with:

  New packets should not begin with @samp{qP} or @samp{qL}.@footnote{The
  @samp{qP} and @samp{qL} packets predate these conventions, and don't
  have any terminator for the packet name; we suspect they are in
  widespread use in places that are difficult to upgrade.}

if you prefer.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]