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: [RFA] Document fixed/floating variable objects and thread-id.


> From: Vladimir Prus <vladimir@codesourcery.com>
> Date: Fri, 4 Apr 2008 13:20:00 +0400
> 
> 
> This patch adds some more docs about variable objects.

Thanks, adding documentation is always welcome.

> 	* gdb/doc/gdb.texinfo (gdb/mi Variable object): Document
> 	fixed and floating variable objects, and clarify that
> 	a variable object can also be found to a thread.  Update
> 	-var-create example.

Some comments and suggestions:

> +Variable objects can be either ``fixed'' or ``floating''. For the

Texinfo has a special markup for introducing new terminology: @dfn.
So please use @dfn{fixed} and @dfn{floating}, as it looks better in
print.

Also, there's only one blank after the end of the sentence here;
please use two.

> +fixed variable object, the expression is parsed when the variable
> +object is created, including associating indentifiers to specific
> +variables.  The meaning of expression never changes.  A floating 
> +variable object has its expression reparsed each time the variable
> +object is updated.  In particular, the meaning of identifiers can
> +change every time.

Instead of ``meaning'' here, isn't it better to say ``value''?

Other than that, this is approved, thanks.


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