[Bug middle-end/113508] New: widen_ssumm3 documentation needs to mention which mode is m here

[Bug middle-end/113508] New: widen_ssumm3 documentation needs to mention which mode is m here

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=113508

            Bug ID: 113508
           Summary: widen_ssumm3 documentation needs to mention which mode
                    is m here
           Product: gcc
           Version: 14.0
            Status: UNCONFIRMED
          Keywords: documentation
          Severity: normal
          Priority: P3
         Component: middle-end
          Assignee: pinskia at gcc dot gnu.org
          Reporter: pinskia at gcc dot gnu.org
  Target Milestone: ---

Reading the documentation for widen_[us]summ3 (and [us]dot_prodm, ssadm at
least) does not say which mode is going to be the m. Is it the wider mode or
the narrow mode.


Filing this so I keep track of the issue. Will add what I find when I finish
and submit a patch.

[Bug middle-end/113508] widen_ssumm3 documentation needs to mention which mode is m here

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=113508

Andrew Pinski <pinskia at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |ASSIGNED
     Ever confirmed|0                           |1
   Last reconfirmed|                            |2024-01-19

[Bug middle-end/113508] widen_ssumm3 documentation needs to mention which mode is m here

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=113508

--- Comment #1 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
The current documentation reads:
```
Operands 0 and 2 are of the same mode, which is wider than the mode of operand
1. Add operand 1 to operand 2 and place the widened result in operand 0. (This
is used express accumulation of elements into an accumulator of a wider mode.)
```

The m mode here  is the smaller mode.

So it would be better if it read:
```
Operands 0 and 2 are of the same mode, which is wider than the mode (m) of
operand 1. Add operand 1 to operand 2 and place the widened result in operand
0. (This is used express accumulation of elements into an accumulator of a
wider mode.)
```

All of the other ones are still the smaller mode too.

[Bug middle-end/113508] widen_ssumm3 documentation needs to mention which mode is m here

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=113508

--- Comment #2 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
There are few other changes I am going to make too.

[Bug middle-end/113508] widen_ssumm3 documentation needs to mention which mode is m here

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=113508

--- Comment #3 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
part 1 which just fixes some style issue:
https://gcc.gnu.org/pipermail/gcc-patches/2024-February/645630.html

part 2:
https://gcc.gnu.org/pipermail/gcc-patches/2024-February/645631.html

[Bug middle-end/113508] widen_ssumm3 documentation needs to mention which mode is m here

[cvs-commit at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=113508

--- Comment #4 from GCC Commits <cvs-commit at gcc dot gnu.org> ---
The trunk branch has been updated by Andrew Pinski <pinskia@gcc.gnu.org>:

https://gcc.gnu.org/g:5329b94188206e9f8c96d9a63931c415fa5d39d7

commit r14-9006-g5329b94188206e9f8c96d9a63931c415fa5d39d7
Author: Andrew Pinski <quic_apinski@quicinc.com>
Date:   Wed Feb 14 14:29:22 2024 -0800

    doc: Add documentation of which operand matches the mode of the standard
pattern name [PR113508]

    In some of the standard pattern names, it is not obvious which mode is
being used in the pattern
    name. Is it operand 0, 1, or 2? Is it the wider mode or the narrower mode?
    This fixes that so there is no confusion by adding a sentence to some of
them.

    Built the documentation to make sure that it builds.

    gcc/ChangeLog:

            PR middle-end/113508
            * doc/md.texi (sdot_prod@var{m}, udot_prod@var{m},
            usdot_prod@var{m}, ssad@var{m}, usad@var{m}, widen_usum@var{m}3,
            smulhs@var{m}3, umulhs@var{m}3, smulhrs@var{m}3, umulhrs@var{m}3):
            Add sentence about what the mode m is.

    Signed-off-by: Andrew Pinski <quic_apinski@quicinc.com>

[Bug middle-end/113508] widen_ssumm3 documentation needs to mention which mode is m here

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=113508

Andrew Pinski <pinskia at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Resolution|---                         |FIXED
             Status|ASSIGNED                    |RESOLVED
   Target Milestone|---                         |14.0

--- Comment #5 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
Fixed.