Re: gengtype improvements for plugins, completed! patch 7/N [doc]

[Laurynas Biveinis <laurynas dot biveinis at gmail dot com>]

+file. The @var{gtype.state} is usually in the plugin directory.

Double space before a new sentence, also might change when it is
finally decided where does that file actually go.

+The @code{gengtype} utility (which may be installed as
+@code{gcc-gengtype} or some other name on your system) is a C code

I guess this will be finalized when the name is settled but "or some
other name on your system)" is redundant

+generator program.  It generates suitable marking and type-walking C
+routines for GGC.  Generated GC marking routines ensure that every

"for GGC and PCH."

+live data is ultimately marked, so that GGC can delete, at the end of
+its @code{ggc_collect} function, every non-marked data (which is
+unreachable and dead).  Generated PCH type-walking routines are used
+for ``compilation'' of header files @var{*.h} into a @var{*.gch}
+file.

Looks redundant to me.


+The @code{gengtype} utility is run once specially when compiling GCC

I'd remove "specially"

+itself.  It parses many GCC source files (mostly internal GCC headers
+declaring @code{GTY}-ed types and internal GCC files declaring
+@code{GTY}-ed variables). It saves its state in a persistent textual

The comment in parentheses looks redundant to me.

+file @file{gtype.state}.  This file has a format tied to a particular
+GCC release and configuration.  This @file{gtype.state} file should be
+parsed only by @code{gengtype} (of the same version which has
+generated it).  Following GNU usage, @code{gengtype} accepts the usual

Do you enforce this in the code?


2010/9/11 Basile Starynkevitch <basile@starynkevitch.net>:
>
> Hello All,
>
> [join work by Basile Starynkevitch & Jeremie Salvucci]
>
> References:
> Âhttp://gcc.gnu.org/ml/gcc-patches/2010-08/msg02060.html
> Âhttp://gcc.gnu.org/ml/gcc-patches/2010-09/msg00616.html
> Âhttp://gcc.gnu.org/ml/gcc-patches/2010-09/msg00663.html
> Âhttp://gcc.gnu.org/ml/gcc-patches/2010-08/msg02063.html
> Âhttp://gcc.gnu.org/ml/gcc-patches/2010-08/msg02065.html
> Âhttp://gcc.gnu.org/ml/gcc-patches/2010-08/msg02068.html
> Âhttp://gcc.gnu.org/ml/gcc-patches/2010-09/msg00983.html
> Âhttp://gcc.gnu.org/ml/gcc-patches/2010-08/msg02069.html
> Âhttp://gcc.gnu.org/ml/gcc-patches/2010-09/msg01029.html
>
> The 7th and last part [doc] of our patch series "completed!" is a
> documentation patch. I added a few missing sentences about some GTY
> tags, and I documented imperfectly the new gengtype prorgram
> interface, in particular its gengtype state facility.
>
> Since I did not sent any patch on documentation, the difference is
> only on gty.texi and has been obtained with
>
> svn diff -x -p gcc/doc/gty.texi > ~/tmp/gengtype_patch_7_of_N__doc.diff
>
> You can apply it to the trunk 163987 or to the previous patch 6/N [wstate].
>
> As usual, I am attaching for convenience the cumulated patches against
> trunk 163987 as a gzip file
> gengtype_patch_7_of_N__doc-cumulatedto07-trunrev-163987.diff.gz
>
> Jeremie did not write any documentation, so please blame (gently!) me
> for the english mistakes etc, and suggest better phrasing.
>
> #################### gcc/ChangeLog entry for documentation
> 2010-09-11 ÂBasile Starynkevitch Â<basile@starynkevitch.net>
>
> Â Â Â Â* gcc/doc/gty.texi:
> Â Â Â Â(Generating GGC code with gengtype): New node.
> Â Â Â Â(GTY Options): Documented that tag should be unique.
> Â Â Â ÂAdded ptr_alias documentation.
> Â Â Â Â(How to run the gengtype generator): New section.
> ################################################################
>
> Comments are welcome.
>
> Cheers.
> --
> Basile STARYNKEVITCH Â Â Â Â http://starynkevitch.net/Basile/
> email: basile<at>starynkevitch<dot>net mobile: +33 6 8501 2359
> 8, rue de la Faiencerie, 92340 Bourg La Reine, France
> *** opinions {are only mines, sont seulement les miennes} ***
>



-- 
Laurynas