[PATCH][GCC][DOCS] Remove rtl.texi references to old RTX code class names

[PATCH][GCC][DOCS] Remove rtl.texi references to old RTX code class names

[Matthew Malcomson]

[-- Attachment #1: Type: text/plain, Size: 2554 bytes --]

Remove rtl.texi references to old RTX code class names

The old names were changed in svn revision
svn+ssh://gcc.gnu.org/svn/gcc/trunk@78824 138bc75d-0d04-0410-961f-82ee72b054a4
but the documentation was not fully updated at the time.

Documentation checked after full build (both .info and .pdf)
Ok for trunk?

2018-08-15  Matthew Malcomson  <matthew.malcomson@arm.com>

gcc/
	* doc/rtl.texi: Replace old RTX class names with new names.


###############     Attachment also inlined for ease of reply    ###############


diff --git a/gcc/doc/rtl.texi b/gcc/doc/rtl.texi
index a37d9ac538991c507985bda4f825023534321b76..70d8b1eddcaec97a98c7db95d9b52257755ead88 100644
--- a/gcc/doc/rtl.texi
+++ b/gcc/doc/rtl.texi
@@ -144,7 +144,8 @@ Currently, @file{rtl.def} defines these classes:
 An RTX code that represents an actual object, such as a register
 (@code{REG}) or a memory location (@code{MEM}, @code{SYMBOL_REF}).
 @code{LO_SUM}) is also included; instead, @code{SUBREG} and
-@code{STRICT_LOW_PART} are not in this class, but in class @code{x}.
+@code{STRICT_LOW_PART} are not in this class, but in class
+@code{RTX_EXTRA}.
 
 @item RTX_CONST_OBJ
 An RTX code that represents a constant object.  @code{HIGH} is also
@@ -166,7 +167,7 @@ An RTX code for a unary arithmetic operation, such as @code{NEG},
 @item RTX_COMM_ARITH
 An RTX code for a commutative binary operation, such as @code{PLUS} or
 @code{AND}.  @code{NE} and @code{EQ} are comparisons, so they have class
-@code{<}.
+@code{RTX_COMM_COMPARE}.
 
 @item RTX_BIN_ARITH
 An RTX code for a non-commutative binary operation, such as @code{MINUS},
@@ -284,26 +285,28 @@ Some classes of RTX codes always have the same format.  For example, it
 is safe to assume that all comparison operations have format @code{ee}.
 
 @table @code
-@item 1
+@item RTX_UNARY
 All codes of this class have format @code{e}.
 
-@item <
-@itemx c
-@itemx 2
+@item RTX_BIN_ARITH
+@item RTX_COMM_ARITH
+@item RTX_COMM_COMPARE
+@itemx RTX_COMPARE
 All codes of these classes have format @code{ee}.
 
-@item b
-@itemx 3
+@item RTX_BITFIELD_OPS
+@itemx RTX_TERNARY
 All codes of these classes have format @code{eee}.
 
-@item i
+@item RTX_INSN
 All codes of this class have formats that begin with @code{iuueiee}.
 @xref{Insns}.  Note that not all RTL objects linked onto an insn chain
-are of class @code{i}.
+are of class @code{RTX_INSN}.
 
-@item o
-@itemx m
-@itemx x
+@item RTX_CONST_OBJ
+@item RTX_OBJ
+@itemx RTX_MATCH
+@itemx RTX_EXTRA
 You can make no assumptions about the format of these codes.
 @end table
 


[-- Attachment #2: rtx-code-class-names.patch --]
[-- Type: text/plain, Size: 2031 bytes --]

diff --git a/gcc/doc/rtl.texi b/gcc/doc/rtl.texi
index a37d9ac538991c507985bda4f825023534321b76..70d8b1eddcaec97a98c7db95d9b52257755ead88 100644
--- a/gcc/doc/rtl.texi
+++ b/gcc/doc/rtl.texi
@@ -144,7 +144,8 @@ Currently, @file{rtl.def} defines these classes:
 An RTX code that represents an actual object, such as a register
 (@code{REG}) or a memory location (@code{MEM}, @code{SYMBOL_REF}).
 @code{LO_SUM}) is also included; instead, @code{SUBREG} and
-@code{STRICT_LOW_PART} are not in this class, but in class @code{x}.
+@code{STRICT_LOW_PART} are not in this class, but in class
+@code{RTX_EXTRA}.
 
 @item RTX_CONST_OBJ
 An RTX code that represents a constant object.  @code{HIGH} is also
@@ -166,7 +167,7 @@ An RTX code for a unary arithmetic operation, such as @code{NEG},
 @item RTX_COMM_ARITH
 An RTX code for a commutative binary operation, such as @code{PLUS} or
 @code{AND}.  @code{NE} and @code{EQ} are comparisons, so they have class
-@code{<}.
+@code{RTX_COMM_COMPARE}.
 
 @item RTX_BIN_ARITH
 An RTX code for a non-commutative binary operation, such as @code{MINUS},
@@ -284,26 +285,28 @@ Some classes of RTX codes always have the same format.  For example, it
 is safe to assume that all comparison operations have format @code{ee}.
 
 @table @code
-@item 1
+@item RTX_UNARY
 All codes of this class have format @code{e}.
 
-@item <
-@itemx c
-@itemx 2
+@item RTX_BIN_ARITH
+@item RTX_COMM_ARITH
+@item RTX_COMM_COMPARE
+@itemx RTX_COMPARE
 All codes of these classes have format @code{ee}.
 
-@item b
-@itemx 3
+@item RTX_BITFIELD_OPS
+@itemx RTX_TERNARY
 All codes of these classes have format @code{eee}.
 
-@item i
+@item RTX_INSN
 All codes of this class have formats that begin with @code{iuueiee}.
 @xref{Insns}.  Note that not all RTL objects linked onto an insn chain
-are of class @code{i}.
+are of class @code{RTX_INSN}.
 
-@item o
-@itemx m
-@itemx x
+@item RTX_CONST_OBJ
+@item RTX_OBJ
+@itemx RTX_MATCH
+@itemx RTX_EXTRA
 You can make no assumptions about the format of these codes.
 @end table
 

Re: [PATCH][GCC][DOCS] Remove rtl.texi references to old RTX code class names

[Sandra Loosemore]

On 08/15/2018 11:17 AM, Matthew Malcomson wrote:
> Remove rtl.texi references to old RTX code class names
> 
> The old names were changed in svn revision
> svn+ssh://gcc.gnu.org/svn/gcc/trunk@78824 138bc75d-0d04-0410-961f-82ee72b054a4
> but the documentation was not fully updated at the time.
> 
> Documentation checked after full build (both .info and .pdf)
> Ok for trunk?
> 
> 2018-08-15  Matthew Malcomson  <matthew.malcomson@arm.com>
> 
> gcc/
> 	* doc/rtl.texi: Replace old RTX class names with new names.
> 
> 
> ###############     Attachment also inlined for ease of reply    ###############

I have no comment on the technical correctness of the patch, but spotted 
a couple markup issues:
>   
> -@item <
> -@itemx c
> -@itemx 2
> +@item RTX_BIN_ARITH
> +@item RTX_COMM_ARITH
> +@item RTX_COMM_COMPARE
> +@itemx RTX_COMPARE
>   All codes of these classes have format @code{ee}.

Use @item for the first item in a group, @itemx for all the others.

> -@item o
> -@itemx m
> -@itemx x
> +@item RTX_CONST_OBJ
> +@item RTX_OBJ
> +@itemx RTX_MATCH
> +@itemx RTX_EXTRA
>   You can make no assumptions about the format of these codes.
>   @end table

Here too.

-Sandra

Re: [PATCH][GCC][DOCS] Remove rtl.texi references to old RTX code class names

[Matthew Malcomson]

[-- Attachment #1: Type: text/plain, Size: 175 bytes --]


On 15/08/18 20:26, Sandra Loosemore wrote:
>
> Use @item for the first item in a group, @itemx for all the others.
>
> -Sandra

Thanks for the spot, updated patch attached.


[-- Attachment #2: rtx-code-class-names.patch --]
[-- Type: text/x-patch, Size: 2034 bytes --]

diff --git a/gcc/doc/rtl.texi b/gcc/doc/rtl.texi
index a37d9ac538991c507985bda4f825023534321b76..f406a99ed78b6ce1fd24e768eefb0e530d7977d6 100644
--- a/gcc/doc/rtl.texi
+++ b/gcc/doc/rtl.texi
@@ -144,7 +144,8 @@ Currently, @file{rtl.def} defines these classes:
 An RTX code that represents an actual object, such as a register
 (@code{REG}) or a memory location (@code{MEM}, @code{SYMBOL_REF}).
 @code{LO_SUM}) is also included; instead, @code{SUBREG} and
-@code{STRICT_LOW_PART} are not in this class, but in class @code{x}.
+@code{STRICT_LOW_PART} are not in this class, but in class
+@code{RTX_EXTRA}.
 
 @item RTX_CONST_OBJ
 An RTX code that represents a constant object.  @code{HIGH} is also
@@ -166,7 +167,7 @@ An RTX code for a unary arithmetic operation, such as @code{NEG},
 @item RTX_COMM_ARITH
 An RTX code for a commutative binary operation, such as @code{PLUS} or
 @code{AND}.  @code{NE} and @code{EQ} are comparisons, so they have class
-@code{<}.
+@code{RTX_COMM_COMPARE}.
 
 @item RTX_BIN_ARITH
 An RTX code for a non-commutative binary operation, such as @code{MINUS},
@@ -284,26 +285,28 @@ Some classes of RTX codes always have the same format.  For example, it
 is safe to assume that all comparison operations have format @code{ee}.
 
 @table @code
-@item 1
+@item RTX_UNARY
 All codes of this class have format @code{e}.
 
-@item <
-@itemx c
-@itemx 2
+@item RTX_BIN_ARITH
+@itemx RTX_COMM_ARITH
+@itemx RTX_COMM_COMPARE
+@itemx RTX_COMPARE
 All codes of these classes have format @code{ee}.
 
-@item b
-@itemx 3
+@item RTX_BITFIELD_OPS
+@itemx RTX_TERNARY
 All codes of these classes have format @code{eee}.
 
-@item i
+@item RTX_INSN
 All codes of this class have formats that begin with @code{iuueiee}.
 @xref{Insns}.  Note that not all RTL objects linked onto an insn chain
-are of class @code{i}.
+are of class @code{RTX_INSN}.
 
-@item o
-@itemx m
-@itemx x
+@item RTX_CONST_OBJ
+@itemx RTX_OBJ
+@itemx RTX_MATCH
+@itemx RTX_EXTRA
 You can make no assumptions about the format of these codes.
 @end table
 

Re: [PATCH][GCC][DOCS] Remove rtl.texi references to old RTX code class names

[Sandra Loosemore]

On 08/16/2018 02:42 AM, Matthew Malcomson wrote:
> 
> On 15/08/18 20:26, Sandra Loosemore wrote:
>>
>> Use @item for the first item in a group, @itemx for all the others.
> 
> Thanks for the spot, updated patch attached.

This version looks fine with me.  Nobody's made any objection about 
technical incorrectness, either, so I think it's OK to check in.

-Sandra

Re: [PATCH][GCC][DOCS] Remove rtl.texi references to old RTX code class names

[Jeff Law]

On 08/16/2018 08:44 AM, Sandra Loosemore wrote:
> On 08/16/2018 02:42 AM, Matthew Malcomson wrote:
>>
>> On 15/08/18 20:26, Sandra Loosemore wrote:
>>>
>>> Use @item for the first item in a group, @itemx for all the others.
>>
>> Thanks for the spot, updated patch attached.
> 
> This version looks fine with me.  Nobody's made any objection about
> technical incorrectness, either, so I think it's OK to check in.
I think it's fine from the technical side as well.
jeff