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 17:12:22 -0500
> From: Bob Rossi <bob@brasko.net>
> Cc: gdb-patches@sources.redhat.com
>
> I really am not good at editing info files but am trying to do my
> best to help out.
You are doing a good job, although I have a few more minor comments,
see below.
The @cindex lines are collected by the program that generates the Info
files and put into the "Index" node. Thereafter, you can use the `i'
command in the Info readers to quickly find stuff in the manual; that
command works by searching the string you type in the index. This is
the most efficient means of using the manual as a reference, when you
know something is in the manual and need a fast way of finding it.
If you want to learn more about Texinfo, I suggest to read the manual
that comes with the Texinfo package.
> +@item
> +For more information on handshaking see @ref{GDB/MI Handshaking Interface}
> +@end itemize
Don't make this an @item (just a simple sentence that goes after @end
itemize), and make sure there's a period or comma after the closing
brace of @ref{...}.
> +However, if @value{GDBN} is started with the -i=mi flag, then this tells
The "-i=mi" part should be in @samp{}.
> +untested protocols, they could simply try to invoke @value{GDBN} with
> +-i=mi@var{N}, where @var{N} is version they wish to communicate with.
Same here. And please don't use caps inside @var{}, as they look ugly
in print.
> +@cindex @dfn{stable MI protocol}
No need for @dfn in the index entries.
> +a CVS snapshot will have depricated @sc{mi} protocols, stable @sc{mi}
^^^^^^^^^^
"deprecated"
> +protocols and development @sc{mi} protocols. The depricated @sc{mi} protocols
^^^^^^^^^^
Same here.
> +eventually get removed. The @dfn{stable MI protocols} are considered stable
@dfn should be used only once, the first time you introduce the term.
After that, simply use the term without any markup or quoting.