Re: [RFA/DOC] record pic

[Eli Zaretskii <eliz at gnu dot org>]

> From: Hui Zhu <teawater@gmail.com>
> Date: Fri, 2 Jul 2010 14:28:54 +0800
> Cc: gdb-patches@sourceware.org
> 
> > What's a vcg file?
> 
> VCG file is "Visualization of Compiler Graphs".  I didn't find other
> good define about it. :(
> There are some introduce about it.
> http://gcc.gnu.org/news/egcs-vcg.html
> http://rw4.cs.uni-sb.de/~sander/html/gsvcg1.html
> 
> To see the file.  I suggest use http://code.google.com/p/vcgviewer/

This information should be added to the docs.

> >> +set record pic hide-nofunction on|off
> >> + ?Set or show whether `record pic' hide the nodes that don't have
> > ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?^^^^
> > "hides"
> >
> > But what does it mean to "hide the nodes"?
> 
> The each line or each function will be show in vcg file as a node.
> Sometime, we don't want show it.  So hide the nodes.

There should be an explanation about this in the manual and in NEWS.

> +set record pic hide-nofunction on|off
> +  Set or show whether `record pic' hides the nodes that don't have
> +  the function name.

What are "the nodes without function name"?

> +set record pic hide-nosource on|off
> +  Set or show whether `record pic' hides the nodes that don't have
> +  the source message.

What are "nodes that don't have the source message"?  And what is a
"source message"?

> +set record pic hide-sameaddr on|off
> +  Set or show whether `record pic' hides the nodes that have the
> +  same address node in vcg file.

Do you mean here multiple nodes that have the same address?  If so,
what will be hidden in that case? all nodes but the first one?

> +@kindex set record pic type

There's no need to index each subcommand of "set record pic",
especially since they all are described one after the other.  It's
good enough to have only one "@kindex set record pic" before the first
subcommand.

> +@item set record pic type @var{type}
> +Set the type of the nodes that @code{record pic} saved.

Do you mean "the type of nodes that @code{record pic} will save"?

> +When @var{type} is set to @code{line} (the default), each node of vcg
> +file that @code{record pic} saved will be a line of the inferior.
> +
> +When @var{type} is set to @code{function}, each node of vcg file that
> +@code{record pic} saved will be a function of the inferior.

Are these two the only types?  If not, what are the other possible
values?

> +If ON (the default), @code{record pic} will hides the nodes that don't
                                          ^^^^^^^^^^
"will hide"

> +If ON (the default), @code{record pic} will hides the nodes that
                                          ^^^^^^^^^^
"will hide"

> +If ON (the default), @code{record pic} will hides the nodes that have

Same here.

> +the same address node in vcg file.  And @code{record pic} will show
> +the execute count number of this node in format @code{c:number}

Show where?  And what is "c" in @code{c:number}?

> +If OFF, @code{record pic} will show the nodes that have the same
> +address node in vcg file.  And @code{record pic} will show the
> +instruction number in format @code{i:number} that
> +@value{record goto} support.

Same here regarding the "i" part.

Thanks.