Re: [RFC] Come up with ipa passes introduction in gccint documentation

[Segher Boessenkool <segher at kernel dot crashing dot org>]

Hi!

Just some editorial comments...  The idea of the patch is fine IMHO.
(I am not maintainer of this, take all my comments for what they are).

On Sun, Sep 29, 2019 at 02:56:37AM -0500, Xiong Hu Luo wrote:
>  To simplify development, the GCC pass manager differentiates
> -between normal inter-procedural passes and small inter-procedural
> -passes.  A @emph{small inter-procedural pass}
> +between normal inter-procedural passes @pxref{All regular ipa passes}
> +and small inter-procedural passes@pxref{All small ipa passes}
> +& @pxref{All late ipa passes}. A @emph{small inter-procedural pass}
>  (@code{SIMPLE_IPA_PASS}) is a pass that does

To simplify development, the GCC pass manager differentiates
between normal inter-procedural passes @pxref{All regular IPA passes},
simple inter-procedural passes@pxref{All simple IPA passes},
and late inter-procedural passes @pxref{All late IPA passes}.
A @emph{simple inter-procedural pass}
(@code{SIMPLE_IPA_PASS}) is a pass that does

Don't use "&", write out the word.  IPA is an abbreviation, not a word,
so it should be written in all caps.  Enumerations are written like this,
that, and something else.  Is there a reason you used "small" instead of
"simple"?

> diff --git a/gcc/doc/passes.texi b/gcc/doc/passes.texi
> index 6edb9a0bfb7..0b6cf73469c 100644
> --- a/gcc/doc/passes.texi
> +++ b/gcc/doc/passes.texi
> @@ -21,6 +21,7 @@ where near complete.
>  * Gimplification pass::  The bits are turned into something we can optimize.
>  * Pass manager::         Sequencing the optimization passes.
>  * Tree SSA passes::      Optimizations on a high-level representation.
> +* IPA passes::           Optimizations on scope of intra-procedual.
>  * RTL passes::           Optimizations on a low-level representation.

I'd just say "Intra-procedural optimizations."  And maybe order this
differntly?  IPA, SSA, RTL, the same order as they run, and this also
keeps the "high/low-level representation" together, which reads a bit
better.

The rest should be worked out a bit more, but looks promising.

Did you test this with both "make info" and "make pdf" (and checked the
result of those of course :-) )?

Thanks,


Segher