This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Re: [PATCH, rs6000] Improve Documentation of Built-In Functions Part 1
Hi!
On Tue, Apr 24, 2018 at 02:25:58PM -0500, Kelvin Nilsen wrote:
> > 4. Remove descriptions of built-in function that do not belong in this
> > section because the
> > built-in functions are generic (not specific to PowerPC):
> > __builtin_fabsq,
> > __builtin_copysignq, __builtin_infq, __builtin_huge_valq, __builtin_nanq,
> > __builtin_nansq, __builtin_sqrtf128, __builtin_fmaf128.
Are these described in a generic place, then? I don't see it?
> +@node Low-Level PowerPC Built-in Functions Available on all Targets
> +@subsubsection Low-Level PowerPC Built-in Functions Available on all Targets
"Targets" is not such a great name. "Configurations", maybe?
> CPU supports the Embedded ISA category.
> @item cellbe
> CPU has a CELL broadband engine.
> +@item darn
> +CPU supports the darn (deliver a random number) instruction.
"the @code{darn}" etc.
> CPU has hardware transaction memory instructions.
> @item htm-nosc
> Kernel aborts hardware transactions when a syscall is made.
> +@item htm-no-suspend
> +CPU supports hardware transaction memory but does not support the
> +tsuspend. instruction.
"@code{tsuspend.} instruction"
> +The following functions require (@option{-mhard-float}),
> +(@option{-mpowerpc-gfxopt}), and (@option{-mpopcntb}) options.
Why the parentheses? The text within parens is not an explanation of
something that came before, it's just part of the main sentence.
Similar in many places.
> +The @code{__builtin_darn} and @code{__builtin_darn_raw}
> +functions require a
> +64-bit environment supporting ISA 3.0 or later.
> +The @code{__builtin_darn} function provides a 64-bit conditioned
> +random number. The @code{__builtin_darn_raw} function provides a
> +64-bit raw random number. The @code{__builtin_darn_32} function
> +provides a 32-bit random number.
Is darn_32 conditioned or raw? (I realise you didn't change this text :-) )
The rest looks great, thanks! If you fix those details, and probably not
delete the q/f128 things yet, it is okay for trunk.
Cheers,
Segher