From: Eli Zaretskii <eliz@gnu.org>
To: gdb@sourceware.org
Subject: Re: [PROPOSAL] Checking for supported packets - revised
Date: Thu, 11 May 2006 06:02:00 -0000 [thread overview]
Message-ID: <uejz18c30.fsf@gnu.org> (raw)
In-Reply-To: <20060510184434.GA13693@nevyn.them.org> (message from Daniel Jacobowitz on Wed, 10 May 2006 14:44:34 -0400)
> Date: Wed, 10 May 2006 14:44:34 -0400
> From: Daniel Jacobowitz <drow@false.org>
>
> > Is there any way to somehow mark this last sentence, so that we will
> > remove it as soon as at least one feature is defined? I'm afraid we
> > will forget.
> >
> > > +Currently, all remote packets which are not mentioned in the response
> > > +will be probed individually, just as if the @samp{qSupported} query
> > > +was not supported. In the future, some new packets may be added to
> >
> > Same here.
>
> Well, I am intending to add a packet of that sort shortly after this
> patch goes in. I couldn't think of any other way to write the
> documentation to reflect the current state, in which there are no
> examples. A @c comment wouldn't help much; it's just as easily
> forgotten.
>
> If you have any ideas on a better way to mark it, I'll do that;
> otherwise, I will simply flag this message, and make sure that
> I revisit it soon.
The best way is to add a comment that has some string for which you
will grep when you make the change that requires the text to be
updated. If you can think about such a string, please add it to the
comment; otherwise I guess we will have to try to remember.
> > > +@item @var{name}?
> > > +The remote protocol packet @var{name} may be supported, and @value{GDBN}
> > > +should attempt to detect the packet when it is needed.
> >
> > "attempt to detect the packet"? Perhaps it's better to say "attempt
> > to detect whether the packet is supported".
>
> How about this?
>
> The remote protocol packet @var{name} may be supported, and @value{GDBN}
> should auto-detect support when it is needed.
That's fine.
> > > +The name of a packet which can be marked as supported or unsupported
> > > +is the text of the packet in this documentation, up to but not
> > > +including the first punctuation character or variable. For example, a
> > > +target which supports hardware watchpoints but not hardware
> > > +breakpoints might report @samp{Z0-;Z1-;Z2+;Z3+;Z4+}. An exception is
> > > +made for @samp{qPart:@var{object}} packets; the name of the packet
> > > +includes the @var{object}, but not the @var{annex}. Individual
> > > +@samp{qPart} objects types must be reported separately.
> >
> > Please add a cross-reference to the two places where the two example
> > packets are described, so that the reader could consult them in case
> > they don't remember the packets' formats by heart.
>
> To Z0 and qPart, you mean? I don't see how to do it. They're not
> nodes; they're @items in tables.
Use @anchor. It lets you specify a location other than a node to
which an @xref can refer. You will find several examples in the
manual.
next prev parent reply other threads:[~2006-05-11 3:39 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-03-14 2:15 [remote] Checking for supported packets Daniel Jacobowitz
2006-03-21 14:28 ` Daniel Jacobowitz
2006-03-22 16:39 ` Paul Koning
2006-03-31 6:38 ` [PROPOSAL] " Daniel Jacobowitz
2006-03-31 9:51 ` Eli Zaretskii
2006-03-31 14:09 ` Daniel Jacobowitz
[not found] ` <uvetuaep4.fsf@gnu.org>
[not found] ` <20060331141958.GA28073@nevyn.them.org>
2006-04-01 10:22 ` Eli Zaretskii
2006-05-10 7:21 ` [PROPOSAL] Checking for supported packets - revised Daniel Jacobowitz
2006-05-10 18:44 ` Eli Zaretskii
2006-05-10 21:49 ` Daniel Jacobowitz
2006-05-11 6:02 ` Eli Zaretskii [this message]
2006-05-11 0:19 ` Jim Blandy
2006-05-11 2:26 ` Daniel Jacobowitz
2006-05-11 2:36 ` Jim Blandy
2006-05-12 13:55 ` Daniel Jacobowitz
2006-05-12 18:24 ` PAUL GILLIAM
2006-05-23 22:11 ` Data for: " Daniel Jacobowitz
2006-05-26 22:12 ` Take three: [PROPOSAL] Checking for supported packets Daniel Jacobowitz
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=uejz18c30.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=gdb@sourceware.org \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).