This is the mail archive of the
gdb-patches@sources.redhat.com
mailing list for the GDB project.
Re: MI handshaking
> Date: Fri, 5 Nov 2004 11:39:33 -0500
> From: Bob Rossi <bob@brasko.net>
> Cc: gdb-patches@sources.redhat.com
>
> +@node GDB/MI Handshaking Syntax
> +@subsection @sc{gdb/mi} Handshaking Syntax
> +
> +@cindex handshaking syntax for @sc{gdb/mi}
> +@cindex @sc{gdb/mi}, handshaking syntax
> +@table @code
> +@item @var{handshake_output} @expansion{}
> +@code{"handshake=@{stable_protocols=@{" @var{mi-protocol-list}
> +"@}" @var{nl}}
I think there's a need here for a cross-reference to the section that
explains the reason and principles of the handshaking (the other
section you wrote), otherwise this table looks awkwardly unexplained.
> +It is possible to start the @sc{gdb/mi} interpreter using -i=mi1, -i=mi2, or
> +simply with -i=mi.
The command-line options should be in @samp{} or in @option{}, like
this:
It is possible to start the @sc{gdb/mi} interpreter using @samp{-i=mi1}
Actually, instead of using literal mi1 and mi2, which could confuse
the reader into thinking that only MI1 and MI2 are supported (think
about someone reading this 10 years from now), I'd say
It is possible to start the @sc{gdb/mi} interpreter using
@samp{-i=mi@var{n}}, where @var{n} is the MI protocol version
(@pxref{Interpreters}). When invoked with a specific version of the
MI interpreter, @value{GDBN} will bypass the handshaking mode and go
directly into...
> +then this tells @value{GDBN} to go into it's handshaking mode with the
^^^^
This should be "its", without the apostrophe.
> +it supports. The term "stable MI protocol" simply means that the protocol
Please use ``this style'' to quote phrases in Texinfo (the result is
prettier in the printed version). Actually, in this case, since you
are introducing a new term, I'd suggest to say
The term @dfn{stable MI protocol} simply means...
Also, a @cindex entry here about stable MI protocol would be useful.
> +untested protocols, they could simply try to invoke @value{GDBN} with -i=miN,
> +where N is version they wish to communicate with.
Please use @var{n} instead of a literal "N" here.
> +If a specific version of @value{GDBN} speaks only one stable MI protocol than
The last woprd should be "then", not "than".
> +versions of the MI protocol, than it will output a list of these protocols
^^^^
Again, "then".
Other than these few minor problems, the documentation patch is
approved. Thanks.