[PATCH:doc] GDB/MI attribute names

Eli Zaretskii eliz@gnu.org
Fri Sep 25 08:09:00 GMT 2009


> Date: Thu, 24 Sep 2009 22:04:04 +1200
> From: nickrob@snap.net.nz (Nick Roberts)
> 
> This patch, slightly paranoid, document the current practice for attribute
> names.  I don't want future names to break exiting parsers.

I agree, assuming that what you wrote is factually correct at this
point, and that we have no good reasons to modify it VSN.  Is that
indeed so?

> + @var{variable} expressions should be alphabetic words or comprise of
> + alphabetic words separated by underscores.               ^^^^^^^^^^^

Don't you meant "comprised of"?

In any case, the text you suggests sounds a bit inaccurate to me.
(Maybe I just don't know enough about MI, so please bear with me.)
You say "variable expressions", but an expression can use operators,
can't it?  If it can, then the operators are not generally alphabetic
characters.

Based on my understanding of what you meant, I suggest to rephrase as
follows:

  Every @var{variable} should be specified as a sequence of alphabetic
  characters and underscores.

Does that reflect correctly what you wanted to say?

Btw, are digit really "verboten"?  If not, replace "alphabetic" with
"alphanumeric" above.

Thanks.



More information about the Gdb-patches mailing list