[PATCH v1] Doc: Add Standard-Names ustrunc and sstrunc for integer modes

[Andrew Pinski]

On Wed, Jul 17, 2024 at 9:20 PM <pan2.li@intel.com> wrote:
>
> From: Pan Li <pan2.li@intel.com>
>
> This patch would like to add the doc for the Standard-Names
> ustrunc and sstrunc,  include both the scalar and vector integer
> modes.

Thanks for doing this and this looks mostly good to me (can't approve it).


>
> gcc/ChangeLog:
>
>         * doc/md.texi: Add Standard-Names ustrunc and sstrunc.
>
> Signed-off-by: Pan Li <pan2.li@intel.com>
> ---
>  gcc/doc/md.texi | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
>
> diff --git a/gcc/doc/md.texi b/gcc/doc/md.texi
> index 7f4335e0aac..f116dede906 100644
> --- a/gcc/doc/md.texi
> +++ b/gcc/doc/md.texi
> @@ -5543,6 +5543,18 @@ means of constraints requiring operands 1 and 0 to be the same location.
>  @itemx @samp{and@var{m}3}, @samp{ior@var{m}3}, @samp{xor@var{m}3}
>  Similar, for other arithmetic operations.
>
> +@cindex @code{ustrunc@var{m}@var{n}2} instruction pattern
> +@item @samp{ustrunc@var{m}@var{n}2}
> +Truncate the operand 1, and storing the result in operand 0.  There will
> +be saturation during the trunction.  The result will be saturated to the
> +maximal value of operand 0 type if there is overflow when truncation.  The
s/type/mode/ .
> +operand 1 must have mode @var{n},  and the operand 0 must have mode @var{m}.
> +Both the scalar and vector integer modes are allowed.
I don't think you need the article `the` here. It reads wrong with it
at least to me.

> +
> +@cindex @code{sstrunc@var{m}@var{n}2} instruction pattern
> +@item @samp{sstrunc@var{m}@var{n}2}
> +Similar but for signed.
> +
>  @cindex @code{andc@var{m}3} instruction pattern
>  @item @samp{andc@var{m}3}
>  Like @code{and@var{m}3}, but it uses bitwise-complement of operand 2
> --
> 2.34.1
>