Re: [mi] organize possible exec async mi oc command reasons

Bob Rossi
2005-03-27T02:56:50Z

On Sat, Mar 26, 2005 at 03:29:05PM +0200, Eli Zaretskii wrote:
> > Date: Sat, 26 Mar 2005 12:36:32 +0200
> > From: "Eli Zaretskii" <eliz@gnu.org>
> >
> > Btw, do we always have @var{reason} after "stopped"? If not, then
> > it's optional and should be inside [...].
>
> In addition, it looks to me like "stopped" states the reason like so:
>
> *stopped,reason="REASON"
>
> If this is true, then the first @table in the section we are talking
> about should say
>
> @table @code
> @item
> *stopped,reason="@var{reason}"
> @end table

Hi Eli,

Thanks for all the excellent suggestions, I can see how this is much
much nicer than what I had. There is probably still room for improving,
what do you think?

BTW, you might already know, but it's worth mentioning, there are 3
types of out-of-band records. In this section only the *stopped, which
is exec-async-output, is mentioned. That's why I added the sentence,
+In particular, the @var{exec-async-output} records.
After this doco and patch is approved, I'm going to enumerate the other
2 case's, status-async-output and notify-async-output.

Also, For each item, I could add the MI commands that could be done to get the
response described. Like, -exec-finish produces function-finished.
However, the user won't know when you get 'read-watchpoint-trigger'.
What do you think? and if so, how would that fit into this description?
Another table perhaps?

Thanks,
Bob Rossi

2005-03-26 Bob Rossi <bob@brasko.net>

* gdb.texinfo (GDB/MI Out-of-band Records): Enumerating the possible
out-of-band exec-async-output reasons.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.233
diff -w -u -r1.233 gdb.texinfo
--- gdb.texinfo 10 Mar 2005 13:12:33 -0000 1.233
+++ gdb.texinfo 27 Mar 2005 02:50:34 -0000
@@ -15416,9 +15416,40 @@
target activity (e.g., target stopped).

The following is a preliminary list of possible out-of-band records.
+In particular, the @var{exec-async-output} records.

@table @code
-@item "*" "stop"
+@item *stopped,reason="@var{reason}"
+@end table
+
+@var{reason} can be one of the following:
+
+@table @code
+@item breakpoint-hit
+A breakpoint was reached.
+@item watchpoint-trigger
+A watchpoint was triggered.
+@item read-watchpoint-trigger
+A read watchpoint was triggered
+@item access-watchpoint-trigger
+An access watchpoint was triggered.
+@item function-finished
+An -exec-finish or similar CLI command was accomplished.
+@item location-reached
+An -exec-until or similar CLI command was accomplished.
+@item watchpoint-scope
+A watchpoint has gone out of scope.
+@item end-stepping-range
+An -exec-next,-exec-next-instruction,-exec-step,-exec-step-instruction or
+similar CLI command was accomplished.
+@item exited-signalled
+The inferior exited because of a signal.
+@item exited
+The inferior exited.
+@item exited-normally
+The inferior exited normally.
+@item signal-received
+A signal was received by the inferior.
@end table