[PATCH][wwwdocs] Improve arm and aarch64-related info in readings.html

[PATCH][wwwdocs] Improve arm and aarch64-related info in readings.html

[Kyrill Tkachov]

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

Hi all,

I noticed that we have a readings.html page that has pointers to documentation of various backends that GCC supports.
The info on arm seems a bit out of date and somewhat confusing, and there is no entry for aarch64.
This patch tries to address that.

The arm entry is updated to not mention armv2(?) and thumb and an aarch64 entry is added with
a link to the ARM documentation.

Ok to commit?

Thanks,
Kyrill

[-- Attachment #2: wwwdocs-readings.patch --]
[-- Type: text/x-patch, Size: 1208 bytes --]

? readings.html~
Index: readings.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/readings.html,v
retrieving revision 1.242
diff -U 3 -r1.242 readings.html
--- readings.html	14 Nov 2015 23:40:21 -0000	1.242
+++ readings.html	15 Feb 2016 13:29:03 -0000
@@ -59,6 +59,11 @@
 </p>
 
 <ul>
+ <li>AArch64
+  <br /><a href="http://infocenter.arm.com/help/index.jsp">
+	ARM Documentation</a>
+ </li>
+
  <li>alpha
    <br />Manufacturer: Compaq (DEC)
    <br /><a href="http://www.tru64unix.compaq.com/docs/base_doc/DOCUMENTATION/V51A_HTML/ARH9MBTE/TITLE.HTM">Calling
@@ -81,12 +86,12 @@
   <br /><a href="http://www.synopsys.com/IP/PROCESSORIP/ARCPROCESSORS/Pages/default.aspx">ARC Documentation</a>
  </li>
 
- <li>arm (armv2, thumb)
-  <br />Manufacturer: Various, by license from ARM
+ <li>ARM
+  <br />Manufacturer: Various, by license from ARM.
   <br />CPUs include: ARM7 and ARM7T series (eg. ARM7TDMI), ARM9 and StrongARM
   <br /><a href="http://infocenter.arm.com/help/index.jsp">ARM Documentation</a>
  </li>
- 
+
  <li>AVR
   <br />Manufacturer: Atmel
   <br /><a href="http://www.atmel.com/products/microcontrollers/avr/">AVR Documentation</a>

Re: [PATCH][wwwdocs] Improve arm and aarch64-related info in readings.html

[James Greenhalgh]

On Thu, May 19, 2016 at 04:27:31PM +0100, Kyrill Tkachov wrote:
> Hi all,
> 
> I noticed that we have a readings.html page that has pointers to
> documentation of various backends that GCC supports.  The info on arm seems a
> bit out of date and somewhat confusing, and there is no entry for aarch64.
> This patch tries to address that.
> 
> The arm entry is updated to not mention armv2(?) and thumb and an aarch64
> entry is added with a link to the ARM documentation.
> 
> Ok to commit?

The AArch64 part looks fine to me, but a paragraph introducing what is
meant by AArch64 ("the 64-bit execution state introduced in the ARMv8-A
architecture profile" - or similar) would be a useful addition. Just
sending our users straight to the full repository of information provided
by ARM may give them too wide a set of readings :).

Thanks,
James

> ? readings.html~
> Index: readings.html
> ===================================================================
> RCS file: /cvs/gcc/wwwdocs/htdocs/readings.html,v
> retrieving revision 1.242
> diff -U 3 -r1.242 readings.html
> --- readings.html	14 Nov 2015 23:40:21 -0000	1.242
> +++ readings.html	15 Feb 2016 13:29:03 -0000
> @@ -59,6 +59,11 @@
>  </p>
>  
>  <ul>
> + <li>AArch64
> +  <br /><a href="http://infocenter.arm.com/help/index.jsp">
> +	ARM Documentation</a>
> + </li>
> +
>   <li>alpha
>     <br />Manufacturer: Compaq (DEC)
>     <br /><a href="http://www.tru64unix.compaq.com/docs/base_doc/DOCUMENTATION/V51A_HTML/ARH9MBTE/TITLE.HTM">Calling
> @@ -81,12 +86,12 @@
>    <br /><a href="http://www.synopsys.com/IP/PROCESSORIP/ARCPROCESSORS/Pages/default.aspx">ARC Documentation</a>
>   </li>
>  
> - <li>arm (armv2, thumb)
> -  <br />Manufacturer: Various, by license from ARM
> + <li>ARM
> +  <br />Manufacturer: Various, by license from ARM.
>    <br />CPUs include: ARM7 and ARM7T series (eg. ARM7TDMI), ARM9 and StrongARM
>    <br /><a href="http://infocenter.arm.com/help/index.jsp">ARM Documentation</a>
>   </li>
> - 
> +
>   <li>AVR
>    <br />Manufacturer: Atmel
>    <br /><a href="http://www.atmel.com/products/microcontrollers/avr/">AVR Documentation</a>

Re: [PATCH][wwwdocs] Improve arm and aarch64-related info in readings.html

[Gerald Pfeifer]

Hi Kyrill,

On Thu, 19 May 2016, Kyrill Tkachov wrote:
> I noticed that we have a readings.html page that has pointers to 
> documentation of various backends that GCC supports. The info on arm 
> seems a bit out of date and somewhat confusing, and there is no entry 
> for aarch64. This patch tries to address that.

I see you have not applied this yet.  In case you were waiting
for any further approvals beyond James': (a) His is sufficient
for doc and web pages around AArch64, and (b) I agree, too. :-)

Gerald

Re: [PATCH][wwwdocs] Improve arm and aarch64-related info in readings.html

[Kyrill Tkachov]

Hi Gerald,

On 28/05/16 21:04, Gerald Pfeifer wrote:
> Hi Kyrill,
>
> On Thu, 19 May 2016, Kyrill Tkachov wrote:
>> I noticed that we have a readings.html page that has pointers to
>> documentation of various backends that GCC supports. The info on arm
>> seems a bit out of date and somewhat confusing, and there is no entry
>> for aarch64. This patch tries to address that.
> I see you have not applied this yet.  In case you were waiting
> for any further approvals beyond James': (a) His is sufficient
> for doc and web pages around AArch64, and (b) I agree, too. :-)

I was going to apply it (with James's suggestions) but I got
sidetracked by other things. I'll do it today.

Thanks,
Kyrill

> Gerald

Re: [PATCH][wwwdocs] Improve arm and aarch64-related info in readings.html

[Kyrill Tkachov]

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


On 28/05/16 21:04, Gerald Pfeifer wrote:
> Hi Kyrill,
>
> On Thu, 19 May 2016, Kyrill Tkachov wrote:
>> I noticed that we have a readings.html page that has pointers to
>> documentation of various backends that GCC supports. The info on arm
>> seems a bit out of date and somewhat confusing, and there is no entry
>> for aarch64. This patch tries to address that.
> I see you have not applied this yet.  In case you were waiting
> for any further approvals beyond James': (a) His is sufficient
> for doc and web pages around AArch64, and (b) I agree, too. :-)

I have committed the attached patch.

Thanks for the feedback.
Kyrill

> Gerald


[-- Attachment #2: wwwdocs-readings.patch --]
[-- Type: text/x-patch, Size: 1295 bytes --]

Index: htdocs/readings.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/readings.html,v
retrieving revision 1.251
diff -U 3 -r1.251 readings.html
--- htdocs/readings.html	29 May 2016 10:16:01 -0000	1.251
+++ htdocs/readings.html	2 Jun 2016 09:28:32 -0000
@@ -59,6 +59,12 @@
 </p>
 
 <ul>
+ <li>AArch64
+  <br />The 64-bit execution state introduced in the ARMv8-A architecture profile.
+  <br /><a href="http://infocenter.arm.com/help/index.jsp">
+	ARM Documentation</a>
+ </li>
+
  <li>alpha
    <br />Manufacturer: Compaq (DEC)
    <br /><a href="http://www.tru64unix.compaq.com/docs/base_doc/DOCUMENTATION/V51A_HTML/ARH9MBTE/TITLE.HTM">Calling
@@ -81,12 +87,12 @@
   <br /><a href="http://www.synopsys.com/IP/PROCESSORIP/ARCPROCESSORS/Pages/default.aspx">ARC Documentation</a>
  </li>
 
- <li>arm (armv2, thumb)
-  <br />Manufacturer: Various, by license from ARM
+ <li>ARM
+  <br />Manufacturer: Various, by license from ARM.
   <br />CPUs include: ARM7 and ARM7T series (eg. ARM7TDMI), ARM9 and StrongARM
   <br /><a href="http://infocenter.arm.com/help/index.jsp">ARM Documentation</a>
  </li>
- 
+
  <li>AVR
   <br />Manufacturer: Atmel
   <br /><a href="http://www.atmel.com/products/microcontrollers/avr/">AVR Documentation</a>