Re: {PATCH] MI Doco [was Re: CLI and GDB/MI...]

[Eli Zaretskii <eliz@gnu.org>]

> From: Nick Roberts <nickrob@snap.net.nz>
> Date: Tue, 30 May 2006 19:16:43 +1200
> Cc: gdb-patches@sources.redhat.com
> 
> OK, here's something along these lines.  Its a bit incomplete but it might
> be good to put something in now, and develop it as our ideas crystallise.

Thanks.  I have a few comments and suggestions:

> + @node GDB/MI Development and Front Ends
> + @section @sc{gdb/mi} Development and Front Ends
> + 
> + The application which takes the MI output and presents the state of the
> + program being debugged to the user is called a @dfn{front end}.

Please add a @cindex entry here.  The text can be the name of the
section, or some permutation thereof.

> + section tries to minimise the problems by describing how the protocol

"minimize", please.  We use the US spelling.

> + If the changes are such that is considered likely that they would
> + necessarily break a front end

I think the following is simpler and more clear:

  If changes are accumulated that are likely to break front ends, ...

> + to the MI version.  Apart from mi0, new versions of GDB will not

Please use "@value{GDBN}" instead of a literal "GDB".

> + The best way to ensure that unexpected changes which break your front
> + end are not made is

  The best way to avoid changes in MI that might unexpectedly break
  your front end is ...

>                 is to make your project known to GDB developers and
> + follow development on @email{gdb@@sources.redhat.com} and
> + @email{gdb-patches@@sources.redhat.com}.  There is also the mailing list
> + @email{dmi-discuss@@lists.freestandards.org}, hosted by the Free Standards
> + Group, which has the aim of creating a a more general MI protocol
> + called Debugger Machine Interface (DMI) that will become a standard
> + for all debuggers, not just GDB.

I suggest an index entry here, something like

  @cindex @sc{gdb/mi} development, mailing lists