[RFA/DOC] record pic

[Eli Zaretskii]

> From: Hui Zhu <teawater@gmail.com>
> Date: Thu, 1 Jul 2010 15:12:25 +0800
> 
> +record pic [<FILENAME>]
> +  Save the execution log to a vcg file.

What's a vcg file?

> +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"?

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

> +  Set or show whether `record pic' hide the nodes that have the
                                      ^^^^
"hides"

> +Default filename is @file{gdb_record_@var{process_id}}.vcg,
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@file{gdb_record_@var{process_id}.vcg}

> +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.

This is a charade that I cannot unlock.  "Node"? "each node will be a
line"?  What does all that mean?

I think it would help if you explain up front what is the VCG file,
how it can be used once created, and what is the significance of
having each "node" in it be line or function.  Then this text will
make sense.

> +Set whether @code{record pic} hide the nodes that don't have
                                 ^^^^
"hides"

> +Set whether @code{record pic} hide the nodes that don't have
                                 ^^^^
"hides"

> +Set whether @code{record pic} hide the nodes that have the same
                                 ^^^^
"hides"

I will get back and review the rest when you add those explanations
and I understand better what is this all about.

Thanks.