Re: [PATCH: gdb/mi + doco] -var-update

[Eli Zaretskii <eliz at gnu dot org>]

> From: Nick Roberts <nickrob@snap.net.nz>
> Date: Tue, 5 Jul 2005 09:17:09 +1200
> Cc: Bob Rossi <bob@brasko.net>, 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.)