This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH] MI Doco
> Thanks; comments below. You can commit after you take care of them.
OK. Committed, thanks.
> > ! 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.
I'm not sure what I meant either. I committed this part, as is, inadvertantly
but I've tried to address it as part of the patch below. Sorry.
> > 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".
I left this unchanged after reading the ensuing discussion. Maybe the other
examples need to be changed.
...
> > + @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.
I've changed this as you've asked, but just note that all I did here was move
existing text.
In the patch below, I'm trying to group the commands in a similar (but not
identical) fashion to the CLI commands in the main part of the manual. To
that end, I would like to have the node ordering:
* GDB/MI Breakpoint Commands::
* GDB/MI Program Context::
* GDB/MI Thread Commands::
* GDB/MI Program Execution::
* GDB/MI Stack Manipulation::
* GDB/MI Variable Objects::
* GDB/MI Data Manipulation::
* GDB/MI Tracepoint Commands::
* GDB/MI Symbol Query::
* GDB/MI File Commands::
* GDB/MI Target Manipulation::
* GDB/MI Miscellaneous Commands::
I've not done this in the patch because it would make it totally unreadable,
of course. Is such an ordering acceptable?
--
Nick http://www.inet.net.nz/~nickrob
2006-06-10 Nick Roberts <nickrob@snap.net.nz>
(GDB/MI Simple Examples): Use @subheading for "A Bad Command".
(GDB/MI Compatibility with CLI): Qualify more carefully.
(GDB/MI Data Manipulation): Remove description of unimplemented
display related commands as variable objects perform this function
and are superior: -display-delete, -display-disable,
-display-enable, -display-insert and -display-list. Move
-environment-cd, -environment-directory, -environment-path
and -environment-pwd to "Program Context".
(GDB/MI Program Control): Rename to "Program Execution". Move
-exec-arguments -exec-abort to...
(GDB/MI Program Context): ...here. New node split from "Data
Manipulation".
*** gdb.texinfo 10 Jun 2006 10:32:33 +1200 1.337
--- gdb.texinfo 10 Jun 2006 11:05:44 +1200
*************** may repeat one or more times.
*** 17256,17262 ****
* GDB/MI Command Description Format::
* GDB/MI Breakpoint Commands::
* GDB/MI Data Manipulation::
! * GDB/MI Program Control::
* GDB/MI File Commands::
@ignore
* GDB/MI Kod Commands::
--- 17256,17263 ----
* GDB/MI Command Description Format::
* GDB/MI Breakpoint Commands::
* GDB/MI Data Manipulation::
! * GDB/MI Program Context::
! * GDB/MI Program Execution::
* GDB/MI File Commands::
@ignore
* GDB/MI Kod Commands::
*************** details about the various output records
*** 17501,17511 ****
@cindex compatibility, @sc{gdb/mi} and CLI
@cindex @sc{gdb/mi}, compatibility with CLI
! For the developers convenience CLI commands can be entered directly.
! However, CLI commands that use sequences of commands such @code{source},
! @code{commands} will not work and commands that result in queries such
! as pending breakpoints and quitting once execution has started will
! default to yes.
This feature may be removed at some stage in the future and it is
recommended that front ends use the @code{-interpreter exec} command.
--- 17502,17510 ----
@cindex compatibility, @sc{gdb/mi} and CLI
@cindex @sc{gdb/mi}, compatibility with CLI
! For the developers convenience CLI commands can be entered directly,
! but there may be some unexpected behaviour. For example, commands
! that query the user will behave as if the user replied yes.
This feature may be removed at some stage in the future and it is
recommended that front ends use the @code{-interpreter exec} command.
*************** Quitting GDB just prints the result clas
*** 17743,17749 ****
<- ^exit
@end smallexample
! @subsubheading A Bad Command
Here's what happens if you pass a non-existent command:
--- 17742,17748 ----
<- ^exit
@end smallexample
! @subheading A Bad Command
Here's what happens if you pass a non-existent command:
*************** next-page="0x000013c0",prev-page="0x0000
*** 18809,18907 ****
(@value{GDBP})
@end smallexample
! @subheading The @code{-display-delete} Command
! @findex -display-delete
!
! @subsubheading Synopsis
!
! @smallexample
! -display-delete @var{number}
! @end smallexample
!
! Delete the display @var{number}.
!
! @subsubheading @value{GDBN} Command
!
! The corresponding @value{GDBN} command is @samp{delete display}.
!
! @subsubheading Example
! N.A.
!
!
! @subheading The @code{-display-disable} Command
! @findex -display-disable
!
! @subsubheading Synopsis
!
! @smallexample
! -display-disable @var{number}
! @end smallexample
!
! Disable display @var{number}.
!
! @subsubheading @value{GDBN} Command
!
! The corresponding @value{GDBN} command is @samp{disable display}.
!
! @subsubheading Example
! N.A.
!
!
! @subheading The @code{-display-enable} Command
! @findex -display-enable
!
! @subsubheading Synopsis
!
! @smallexample
! -display-enable @var{number}
! @end smallexample
!
! Enable display @var{number}.
!
! @subsubheading @value{GDBN} Command
!
! The corresponding @value{GDBN} command is @samp{enable display}.
!
! @subsubheading Example
! N.A.
!
- @subheading The @code{-display-insert} Command
- @findex -display-insert
@subsubheading Synopsis
@smallexample
! -display-insert @var{expression}
@end smallexample
! Display @var{expression} every time the program stops.
@subsubheading @value{GDBN} Command
! The corresponding @value{GDBN} command is @samp{display}.
@subsubheading Example
- N.A.
-
-
- @subheading The @code{-display-list} Command
- @findex -display-list
-
- @subsubheading Synopsis
-
- @smallexample
- -display-list
- @end smallexample
! List the displays. Do not show the current values.
!
! @subsubheading @value{GDBN} Command
!
! The corresponding @value{GDBN} command is @samp{info display}.
!
! @subsubheading Example
! N.A.
@subheading The @code{-environment-cd} Command
--- 18808,18837 ----
(@value{GDBP})
@end smallexample
! @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! @node GDB/MI Program Context
! @section @sc{gdb/mi} Program Context
! @subheading The @code{-exec-arguments} Command
! @findex -exec-arguments
@subsubheading Synopsis
@smallexample
! -exec-arguments @var{args}
@end smallexample
! Set the inferior program arguments, to be used in the next
! @samp{-exec-run}.
@subsubheading @value{GDBN} Command
! The corresponding @value{GDBN} command is @samp{set args}.
@subsubheading Example
! @c FIXME!
! Don't have one around.
@subheading The @code{-environment-cd} Command
*************** The corresponding @value{GDBN} command i
*** 19051,19105 ****
@end smallexample
@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! @node GDB/MI Program Control
! @section @sc{gdb/mi} Program control
These are the asynchronous commands which generate the out-of-band
record @samp{*stopped}. Currently GDB only really executes
asynchronously with remote targets and this interaction is mimicked in
other cases.
- @subheading The @code{-exec-abort} Command
- @findex -exec-abort
-
- @subsubheading Synopsis
-
- @smallexample
- -exec-abort
- @end smallexample
-
- Kill the inferior running program.
-
- @subsubheading @value{GDBN} Command
-
- The corresponding @value{GDBN} command is @samp{kill}.
-
- @subsubheading Example
- N.A.
-
-
- @subheading The @code{-exec-arguments} Command
- @findex -exec-arguments
-
- @subsubheading Synopsis
-
- @smallexample
- -exec-arguments @var{args}
- @end smallexample
-
- Set the inferior program arguments, to be used in the next
- @samp{-exec-run}.
-
- @subsubheading @value{GDBN} Command
-
- The corresponding @value{GDBN} command is @samp{set args}.
-
- @subsubheading Example
-
- @c FIXME!
- Don't have one around.
-
-
@subheading The @code{-exec-continue} Command
@findex -exec-continue
--- 18981,18994 ----
@end smallexample
@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! @node GDB/MI Program Execution
! @section @sc{gdb/mi} Program Execution
These are the asynchronous commands which generate the out-of-band
record @samp{*stopped}. Currently GDB only really executes
asynchronously with remote targets and this interaction is mimicked in
other cases.
@subheading The @code{-exec-continue} Command
@findex -exec-continue
*************** Approximately corresponds to @samp{quit}
*** 21207,21212 ****
--- 21096,21121 ----
^exit
@end smallexample
+
+ @subheading The @code{-exec-abort} Command
+ @findex -exec-abort
+
+ @subsubheading Synopsis
+
+ @smallexample
+ -exec-abort
+ @end smallexample
+
+ Kill the inferior running program.
+
+ @subsubheading @value{GDBN} Command
+
+ The corresponding @value{GDBN} command is @samp{kill}.
+
+ @subsubheading Example
+ N.A.
+
+
@subheading The @code{-gdb-set} Command
@findex -gdb-set