From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-38572-listarch-gdb-patches=sources.redhat.com@sources.redhat.com>
Received: (qmail 30578 invoked by alias); 26 Mar 2005 10:40:10 -0000
Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm
Precedence: bulk
List-Subscribe: <mailto:gdb-patches-subscribe@sources.redhat.com>
List-Archive: <http://sources.redhat.com/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sources.redhat.com>
List-Help: <mailto:gdb-patches-help@sources.redhat.com>, <http://sources.redhat.com/ml/#faqs>
Sender: gdb-patches-owner@sources.redhat.com
Received: (qmail 30493 invoked from network); 26 Mar 2005 10:39:59 -0000
Received: from unknown (HELO legolas.inter.net.il) (192.114.186.24)
  by sourceware.org with SMTP; 26 Mar 2005 10:39:59 -0000
Received: from zaretski (IGLD-80-230-9-205.inter.net.il [80.230.9.205])
	by legolas.inter.net.il (MOS 3.5.6-GR)
	with ESMTP id EAE34282 (AUTH halo1);
	Sat, 26 Mar 2005 12:39:57 +0200 (IST)
Date: Sat, 26 Mar 2005 10:40:00 -0000
From: "Eli Zaretskii" <eliz@gnu.org>
To: gdb-patches@sources.redhat.com
Message-ID: <01c531ef$Blat.v2.4$d2dbeba0@zahav.net.il>
Content-Transfer-Encoding: 7BIT
Content-Type: text/plain; charset=ISO-8859-1
In-reply-to: <20050324210231.GA10808@white> (message from Bob Rossi on Thu, 24
	Mar 2005 16:02:31 -0500)
Subject: Re: [mi] organize possible exec async mi oc command reasons
Reply-to: Eli Zaretskii <eliz@gnu.org>
References: <20050324154602.GA10558@white> <01c530ab$Blat.v2.4$de96e8e0@zahav.net.il> <20050324210231.GA10808@white>
X-SW-Source: 2005-03/txt/msg00335.txt.bz2

> Date: Thu, 24 Mar 2005 16:02:31 -0500
> From: Bob Rossi <bob@brasko.net>
> Cc: gdb-patches@sources.redhat.com
> 
> >     +The following lists the current set of reasons why @sc{gdb/mi} would
> >     +return with *stopped (exec-async-output).  
> > What does this sentence mean? and why there's a `*' before "stopped"?
> > and what's with the "exec-async-output" inside parens?
> > 
> 
> How about I replace that with this, 
> 
> The following enumerates the current set of reasons why @sc{gdb/mi} would
> return with an @var{exec-async-output} command.

This still doesn't look right: if exec-async-output is in @var, it
should stand for something.  Do I understand correctly that it stands
for one of these:

    breakpoint-hit
    watchpoint-trigger
    read-watchpoint-trigger
    access-watchpoint-trigger
    function-finished
    location-reached
    watchpoint-scope
    end-stepping-range
    exited-signalled
    exited
    exited-normally
    signal-received

?  If so, then you should modify the @table with "stopped" like this:

    @table @code
    @item *stopped @var{reason}
    @end table

and then list the possible values for @var{reason}, see below.

Also, these are not commands, so it's wrong to say ``GDB/MI would
return with an EXEC-ASYNC-OUTPUT command''.  You should say something
like

    The following enumerates the current set of possible values for
    @var{reason}.

or, better yet

    @var{reason} can be one of the following:

> >     +A breakpoint was reached, "breakpoint-hit"
> > 
> > This is not an English sentence, AFAIU.
> 
> The list is suppossed to be all of the reasons why GDB would return an
> exec async output command to the FE.
> 
> The first part of each item is a description of why GDB returned, the
> second part is the actual reason GDB/MI will give. 
> (ie "reason=breakpoint-hit").

Then you should use @table, like this:

    @table @code
    @item breakpoint-hit
    A breakpoint was reached.
    @item watchpoint-trigger
    A watchpoint was triggered.
    ...
    @end table

Btw, do we always have @var{reason} after "stopped"?  If not, then
it's optional and should be inside [...].