This is the mail archive of the gdb-patches@sources.redhat.com mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

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


 > >   Returns a list of the children of the specified variable object.  With
 > >   just the variable object name as an argument or with an optional
 > > ! preceding argument of 0 or @code{--no-values}, prints only the names
 > > ! of the variables.  With an optional value for @var{print-values} of 1
 > > ! or @code{--with-values}, also prints their values.
 > 
 > It's better to say
 > 
 >   If @var{print-values} is 1 or @code{--with-values}, also prints
 >   their values.
 > 
 > And similarly in the other hunk where @var{print-values} is
 > mentioned.

Clearly this reads much better, but will the reader realise that print-values
is optional? The use of square brackets is explained but this is right at the
beginning of the section on GDB/MI.


Nick


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]