This is the mail archive of the gdb-patches@sourceware.org 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: -var-info-path-expression


> From: Vladimir Prus <ghost@cs.msu.su>
> Date: Tue, 28 Aug 2007 21:16:33 +0400
> 
> Vladimir Prus wrote:
> 
> > 
> > This is the hopefully final revision of the patch
> > to add the -var-info-path-expression command.
> > The code part of the patch was already approved in:
> > 
> > http://article.gmane.org/gmane.comp.gdb.patches/34902
> [...]
> > Eli, do doc changes look fine?

Here are my comments:

> +Returns the expression that is represented by the variable object
> +@var{name}, that is relative to parent variable object and is
> +suitable for presenting this variable object is user interface:
                                                ^^
That "is" looks like a typo.  Did you mean "in", perhaps?

> +@smallexample
> + -var-info-path-expression @var{name}
> +@end smallexample
> +
> +Returns a full expression that can be evaluated in the current
> +context and corresponds to the variable object.  Unlike the
> +@code{-var-info-expression} command, the returned expression is not relative
> +to parent and can be used to create another variable object that will
> +always have the same value as the other variable object.  Typical
> +use of @code{-var-info-path-expression} is creating a watchpoint from
> +a variable object.
> +
> +Example output:
>  @smallexample
>   lang=@var{lang-spec},exp=@var{expression}
>  @end smallexample

I'd like to improve the documentation of -var-info-path-expression and
-var-info-expression, such that the difference between them is clearly
explained.  Right now, having read the documentation of both of them,
I am confused about how they differ.  What does it mean, exactly,
"expression represented by the variable object", and what does it mean
"relative to parent variable object"?  The examples don't help,
either, because they are identical.

How about if you write a real-life example of the output generated by
both commands (i.e. with real expressions, not @var{something}), and
place both of the examples in each section to show how the two
commands differ?  Alternatively, have only one example in each
section, and point to the other, as in "Contrast this with the output
generated by -var-info-path-expression below."

> --- gdb/doc/gdb.texinfo	(revision 4579)
> +++ gdb/doc/gdb.texinfo	(local)

Why there are two patches for gdb.texinfo?


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