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

> From: Nick Roberts <nickrob@snap.net.nz>
> Date: Sun, 27 Feb 2005 21:22:05 +1300
> Cc: gdb-patches@sources.redhat.com
> 
>  >   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.

I think the use of [this] for optional parts is sufficiently
widespread in computer-related documentation, for this to be quite
clear.
Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]