diff mbox series

[1/3] docs: rtl: document GET_MODE_INNER

Message ID 20240502185924.2060196-2-vineetg@rivosinc.com
State New
Headers show
Series Miscll fixlets | expand

Commit Message

Vineet Gupta May 2, 2024, 6:59 p.m. UTC
gcc/ChangeLog
	* doc/rtl.texi: Add entry for GET_MODE_INNER.

Signed-off-by: Vineet Gupta <vineetg@rivosinc.com>
---
 gcc/doc/rtl.texi | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Jeff Law May 2, 2024, 8:36 p.m. UTC | #1
On 5/2/24 12:59 PM, Vineet Gupta wrote:
> gcc/ChangeLog
> 	* doc/rtl.texi: Add entry for GET_MODE_INNER.
> 
> Signed-off-by: Vineet Gupta <vineetg@rivosinc.com>
> ---
>   gcc/doc/rtl.texi | 4 ++++
>   1 file changed, 4 insertions(+)
> 
> diff --git a/gcc/doc/rtl.texi b/gcc/doc/rtl.texi
> index 8ea6588cb71f..f1643f41dfc6 100644
> --- a/gcc/doc/rtl.texi
> +++ b/gcc/doc/rtl.texi
> @@ -1582,6 +1582,10 @@ less than or equal to @code{HOST_BITS_PER_INT}.
>   @item GET_MODE_ALIGNMENT (@var{m})
>   Return the required alignment, in bits, for an object of mode @var{m}.
>   
> +@findex GET_MODE_INNER
> +@item GET_MODE_INNER (@var{m})
> +Returns the mode of subunits contained in a complex mode such as Vector.
I'd probably use the macro's docs nearly verbatim:

> /* Return the mode of the basic parts of MODE.  For vector modes this is the
>    mode of the vector elements.  For complex modes it is the mode of the real
>    and imaginary parts.  For other modes it is MODE itself.  */



OK with that change.

jeff
diff mbox series

Patch

diff --git a/gcc/doc/rtl.texi b/gcc/doc/rtl.texi
index 8ea6588cb71f..f1643f41dfc6 100644
--- a/gcc/doc/rtl.texi
+++ b/gcc/doc/rtl.texi
@@ -1582,6 +1582,10 @@  less than or equal to @code{HOST_BITS_PER_INT}.
 @item GET_MODE_ALIGNMENT (@var{m})
 Return the required alignment, in bits, for an object of mode @var{m}.
 
+@findex GET_MODE_INNER
+@item GET_MODE_INNER (@var{m})
+Returns the mode of subunits contained in a complex mode such as Vector.
+
 @findex GET_MODE_UNIT_SIZE
 @item GET_MODE_UNIT_SIZE (@var{m})
 Returns the size in bytes of the subunits of a datum of mode @var{m}.