From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16659 invoked by alias); 4 Jul 2005 22:24:14 -0000 Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sources.redhat.com Received: (qmail 16544 invoked by uid 22791); 4 Jul 2005 22:23:53 -0000 Received: from legolas.inter.net.il (HELO legolas.inter.net.il) (192.114.186.24) by sourceware.org (qpsmtpd/0.30-dev) with ESMTP; Mon, 04 Jul 2005 22:23:53 +0000 Received: from HOME-C4E4A596F7 (IGLD-84-228-241-110.inter.net.il [84.228.241.110]) by legolas.inter.net.il (MOS 3.5.8-GR) with ESMTP id EUW01143 (AUTH halo1); Tue, 5 Jul 2005 01:23:47 +0300 (IDT) Date: Mon, 04 Jul 2005 22:24:00 -0000 Message-Id: From: Eli Zaretskii To: Nick Roberts CC: bob@brasko.net, gdb-patches@sources.redhat.com In-reply-to: <17097.42837.514419.9496@farnswood.snap.net.nz> (message from Nick Roberts on Tue, 5 Jul 2005 09:17:09 +1200) Subject: Re: [PATCH: gdb/mi + doco] -var-update Reply-to: Eli Zaretskii References: <16929.8147.933720.246602@farnswood.snap.net.nz> <16955.41017.161288.832646@farnswood.snap.net.nz> <20050401024942.GA2179@white> <17013.35649.62745.226730@farnswood.snap.net.nz> <20050502040526.GA10023@nevyn.them.org> <17013.54662.20554.239976@farnswood.snap.net.nz> <20050617034329.GH17013@nevyn.them.org> <20050617140410.GA24575@nevyn.them.org> <20050703195630.GM13811@nevyn.them.org> <17097.42837.514419.9496@farnswood.snap.net.nz> X-SW-Source: 2005-07/txt/msg00052.txt.bz2 > From: Nick Roberts > Date: Tue, 5 Jul 2005 09:17:09 +1200 > Cc: Bob Rossi , gdb-patches@sources.redhat.com > > I've changed the English slightly from last time, and because > "-var-list-children" and "-var-update" have the same optional argument, I only > describe it explictly once. "-stack-list-locals" is slightly different > because print-values is not optional and "--print-simple-values" prints the > type also. > > I've also corrected a spelling and made a couple of changes to the > GDB/MI command description format to reflect reality. Thanks. Allow me a few comments: > +Display the local variable names for the current frame. A value for > +@var{print-values} of 0 or @code{--no-values}, prints only the names > +of the variables; a value of 1 or @code{--all-values}, prints also > +their values; and a value of 2 or @code{--simple-values}, prints the > +name, type and value for simple data types and the name and type for > +arrays, structures and unions. It would be much simpler to rephrase like this: Display the local variable names for the current frame. If @var{print-values} is 0 or @code{--no-values}, print only the names of the variables; if it is 1 or @code{--all-values}, print their values as well; if it is 2 or @code{--simple-values}, print ... you get the point. Note that I also changed "prints" -> "print", since the sentence before that says "Display", not "Displays". > +In this last case, the idea is that > +the user can see the value of simple data types immediately and he can > +create variable objects for other data types if he wishes to explore > +their values in more detail. I think the GNU project's convention is not to use "he" where "she" is also possible. > +Returns a list of the children of the specified variable object. A > +single argument or an optional value for @var{print-values} of 0 or > +@code{--no-values}, prints only the names of the variables; a value > +for @var{print-values} of 1 or @code{--all-values}, also prints their > +values; and a value of 2 or @code{--simple-values} prints the name and > +value for simple data types and just the name for arrays, structures > +and unions. This could also use similar rephrasing. > -A @samp{*} causes all existing variable objects to be updated. > +A @samp{*} causes all existing variable objects to be updated. These two lines are identical, except that the second one has 2 trailing blanks. Please remove those blanks. > +The option @var{print-values} determines whether names and values, or > +just names are printed in the manner described for @code{-var-list-children}. Please add a cross-reference here that points to the description of "-var-list-children". (Since the commands don't have each one its own node, you will have to use @anchor to create a point-able place for the xref.)