Re: [PATCH] MI Doco

[Eli Zaretskii <eliz@gnu.org>]

> From: Nick Roberts <nickrob@snap.net.nz>
> Date: Sun, 4 Jun 2006 11:56:15 +1200
> Cc: gdb-patches@sources.redhat.com
> 
> Here's a patch.

Thanks; comments below.  You can commit after you take care of them.

> ! For the developers convenience CLI commands can be entered directly.

"entered directly" is not clear.  How about this:

  For developers' convenience, GDB/MI supports CLI commands even
  without @code{-interpreter-exec}.

> ! However, CLI commands that use sequences of commands such @code{source},
> ! @code{commands} will not work

I don't understand from this text what will not work.  (Please enclose
input that would be typed by user in @kbd, btw.)  Do you mean if I
type "source, commands", it will not work?  Or do you mean something
else?

Also, you are missing "as" after "such", I think.

>    and commands that result in queries such
> ! as pending breakpoints and quitting once execution has started will
> ! default to yes.

"..commands that query the user will behave as if the user replied yes."

> ! target.  This is only present when GDB's event loop

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

>  is truely asynchronous which is currently only the case for remote targets.

You mean "truly", I think.

Also, there should be a comma after "asynchronous".

> + @smallexample
> + -> -break-insert main
> + <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
> +     enabled="y",addr="0x08048564",func="main",file="myprog.c",
> +     fullname="/home/nickrob/myprog.c",line="68",times="0"@}
> + <- (gdb)

Please use "(@value{GDBP})" instead of a literal "(gdb)".

> + not been implemented yet and these are labelled N.A.@: (not available).
                                           ^^^^^^^^
"labeled"

> ! Executes one machine instruction.  If the instruction is a function
> ! call continues until the function returns.  If the program stops at an
        ^
A comma needed here.

> + @subheading @value{GDBN} Command
> + 
> + The corresponding @value{GDBN} command is @samp{set inferior-tty /dev/pts/1}.

I think you should have only "set inferior-tty" in the @samp, the
argument is just an example of the command's usage, and thus doesn't
belong here.