[PATCH v2] docs: Add documentation for ARC processors

[Alexey Brodkin]

Hi Jonathan,
 
> > Signed-off-by: Alexey Brodkin <abrodkin at synopsys.com>
> > Cc: Randy Dunlap <rdunlap at infradead.org>
> > Cc: Vineet Gupta <vgupta at kernel.org>
> 
> I've applied this set, but I have a couple of quibbles that it would be
> nice to see addressed...

Thanks for taking care of that!

> > +3. `<https://www.synopsys.com/designware-ip/processor-solutions.html>`_ -
> > +Official Synopsys ARC Processors website location, with access to some IP
> > +documentation (Programmer's Reference Manuals, AKA "PRM's", see
> > +`<https://www.synopsys.com/dw/doc.php/ds/cc/programmers-reference-manual-ARC-HS.pdf>`_)
> 
> This manual requires registration (with a fair amount of information
> required) to get.  That should at least be mentioned if we can't find a
> less obnoxious version out there.

Well, I'm afraid that's the best we may get as of now. I wish is was available
with no registration whatsoever, but at least it could be easily had now by
wide audience.

Anyways, I'm wondering what kind of mention do you think is appropriate here?
Somehting like: "note, registration is required"?
 
> > +Building the Linux kernel for ARC processors
> > +############################################
> > +
> > +The process of kernel building for ARC processors is the same as for any other
> > +architecture and could be done in 2 ways:
> > +
> > +1. cross-compilation: process of compiling for ARC targets on a development
> > +host with a different processor architecture (generally x86_64/amd64).
> > +
> > +2. native compilation: process of compiling for ARC on a ARC platform
> > +(hardware board or a simulator like QEMU) with complete development environment
> > +(GNU toolchain, dtc, make etc) installed on the platform.
> 
> These enumerated lists would render a lot more pleasantly if you
> actually formatted them as RST enumerated lists - with lines after the
> first indented.

Indeed, I'm much more used to Markdown and there it works ;)
So should I send a re-spin with fixed version?

 
> > +In both cases, up-to-date GNU toolchain for ARC for the host is needed.
> > +Synopsys offers prebuilt toolchain releases which can be used for this purpose,
> > +available from:
> > +
> > +1. Synopsys GNU toolchain releases:
> > +`<https://urldefense.com/v3/__https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases__;!!A4F2R9G_pg!N40JBI0hlr_f_ZX-pTGEO-vBvxNaA6NF4WYKA3yamILtuUOhgiEsFqRLfdx9VfetWmy7or8$ >`_
> > +2. Linux kernel compilers collection:
> > +`<https://urldefense.com/v3/__https://mirrors.edge.kernel.org/pub/tools/crosstool/__;!!A4F2R9G_pg!N40JBI0hlr_f_ZX-pTGEO-vBvxNaA6NF4WYKA3yamILtuUOhgiEsFqRLfdx9VfetayTOVRo$ >`_
> > +3. Bootlin's toolchain collection: `<https://urldefense.com/v3/__https://toolchains.bootlin.com/__;!!A4F2R9G_pg!N40JBI0hlr_f_ZX-pTGEO-vBvxNaA6NF4WYKA3yamILtuUOhgiEsFqRLfdx9Vfet7I-6RoI$ >`_
> 
> These, in particular, render in a pretty ugly way.

Right, here it gets even worse due to missing newlines. Again, fixed by:
-------------------------->8----------------------------
diff --git a/Documentation/arc/arc.rst b/Documentation/arc/arc.rst
index 249d03c6be8e..4dbd107f02e6 100644
--- a/Documentation/arc/arc.rst
+++ b/Documentation/arc/arc.rst
@@ -10,23 +10,23 @@ Below are some resources where more information can be found on
 ARC processors and relevant open source projects.

 1. `<https://embarc.org/>`_ - Community portal for open source on ARC.
-Good place to start to find relevant FOSS projects, toolchain releases,
-news items and more.
+   Good place to start to find relevant FOSS projects, toolchain releases,
+   news items and more.

 2. `<https://github.com/foss-for-synopsys-dwc-arc-processors>`_ -
-Home for all development activities regarding open source projects for
-ARC processors. Some of the projects are forks of various upstream projects,
-where "work in progress" is hosted prior to submission to upstream projects.
-Other projects are developed by Synopsys and made available to community
-as open source for use on ARC Processors.
+   Home for all development activities regarding open source projects for
+   ARC processors. Some of the projects are forks of various upstream projects,
+   where "work in progress" is hosted prior to submission to upstream projects.
+   Other projects are developed by Synopsys and made available to community
+   as open source for use on ARC Processors.

 3. `<https://www.synopsys.com/designware-ip/processor-solutions.html>`_ -
-Official Synopsys ARC Processors website location, with access to some IP
-documentation (Programmer's Reference Manuals, AKA "PRM's", see
-`<https://www.synopsys.com/dw/doc.php/ds/cc/programmers-reference-manual-ARC-HS.pdf>`_)
-and commercial tools (Free nSIM,
-`<https://www.synopsys.com/cgi-bin/dwarcnsim/req1.cgi>`_ and
-MetaWare Light Edition, `<https://www.synopsys.com/cgi-bin/arcmwtk_lite/reg1.cgi>`_)
+   Official Synopsys ARC Processors website location, with access to some IP
+   documentation (Programmer's Reference Manuals, AKA "PRM's", see
+   `<https://www.synopsys.com/dw/doc.php/ds/cc/programmers-reference-manual-ARC-HS.pdf>`_)
+   and commercial tools (Free nSIM,
+   `<https://www.synopsys.com/cgi-bin/dwarcnsim/req1.cgi>`_ and
+   MetaWare Light Edition, `<https://www.synopsys.com/cgi-bin/arcmwtk_lite/reg1.cgi>`_)

 Important note on ARC processors configurability
 ################################################
@@ -53,20 +53,22 @@ The process of kernel building for ARC processors is the same as for any other
 architecture and could be done in 2 ways:

 1. cross-compilation: process of compiling for ARC targets on a development
-host with a different processor architecture (generally x86_64/amd64).
+   host with a different processor architecture (generally x86_64/amd64).

 2. native compilation: process of compiling for ARC on a ARC platform
-(hardware board or a simulator like QEMU) with complete development environment
-(GNU toolchain, dtc, make etc) installed on the platform.
+   (hardware board or a simulator like QEMU) with complete development environment
+   (GNU toolchain, dtc, make etc) installed on the platform.

 In both cases, up-to-date GNU toolchain for ARC for the host is needed.
 Synopsys offers prebuilt toolchain releases which can be used for this purpose,
 available from:

 1. Synopsys GNU toolchain releases:
-`<https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases>`_
+   `<https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases>`_
+
 2. Linux kernel compilers collection:
-`<https://mirrors.edge.kernel.org/pub/tools/crosstool/>`_
+   `<https://mirrors.edge.kernel.org/pub/tools/crosstool/>`_
+
 3. Bootlin's toolchain collection: `<https://toolchains.bootlin.com/>`_

 Once the toolchain is installed in the system, make sure its "bin" folder
-------------------------->8----------------------------

-Alexey