linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/5] docs: arm: Improvements to Marvell SoC documentation
@ 2021-01-29 18:39 Lubomir Rintel
  2021-01-29 18:39 ` [PATCH 1/5] docs: arm: marvell: turn the automatic links into labels Lubomir Rintel
                   ` (4 more replies)
  0 siblings, 5 replies; 8+ messages in thread
From: Lubomir Rintel @ 2021-01-29 18:39 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Maen Suleiman, Lior Amsalem, Thomas Petazzoni, Andrew Lunn,
	Nicolas Pitre, Eric Miao, linux-doc, linux-kernel

Hi,

please consider applying the patches chained to this message.

The objective is to deal with the a large amount of dead links to
material that often comes handy in marvel.rst; and improve some details
along the way.

Thank you
Lubo



^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH 1/5] docs: arm: marvell: turn the automatic links into labels
  2021-01-29 18:39 [PATCH 0/5] docs: arm: Improvements to Marvell SoC documentation Lubomir Rintel
@ 2021-01-29 18:39 ` Lubomir Rintel
  2021-01-30  0:20   ` Jonathan Corbet
  2021-01-29 18:39 ` [PATCH 2/5] docs: arm: marvell: drop some dead links Lubomir Rintel
                   ` (3 subsequent siblings)
  4 siblings, 1 reply; 8+ messages in thread
From: Lubomir Rintel @ 2021-01-29 18:39 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Maen Suleiman, Lior Amsalem, Thomas Petazzoni, Andrew Lunn,
	Nicolas Pitre, Eric Miao, linux-doc, linux-kernel,
	Lubomir Rintel

Lines ending with obscenely long URLs at the end don't look good.

Even if these links are not that long at this point, they will be when
replaced with an archive link in a subsequent patch -- let's prepare for
that.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
---
 Documentation/arm/marvel.rst | 209 ++++++++++++++++++++++++-----------
 1 file changed, 143 insertions(+), 66 deletions(-)

diff --git a/Documentation/arm/marvel.rst b/Documentation/arm/marvel.rst
index 16ab2eb085b86..716551f9b60a1 100644
--- a/Documentation/arm/marvel.rst
+++ b/Documentation/arm/marvel.rst
@@ -18,12 +18,12 @@ Orion family
         - 88F5181L
         - 88F5182
 
-               - Datasheet: http://www.embeddedarm.com/documentation/third-party/MV88F5182-datasheet.pdf
-               - Programmer's User Guide: http://www.embeddedarm.com/documentation/third-party/MV88F5182-opensource-manual.pdf
-               - User Manual: http://www.embeddedarm.com/documentation/third-party/MV88F5182-usermanual.pdf
+               - Datasheet: `MV88F5182-datasheet.pdf`_
+               - Programmer's User Guide: `MV88F5182-opensource-manual.pdf`_
+               - User Manual: `MV88F5182-usermanual.pdf`_
         - 88F5281
 
-               - Datasheet: http://www.ocmodshop.com/images/reviews/networking/qnap_ts409u/marvel_88f5281_data_sheet.pdf
+               - Datasheet: `marvel_88f5281_data_sheet.pdf`_
         - 88F6183
   Core:
 	Feroceon 88fr331 (88f51xx) or 88fr531-vd (88f52xx) ARMv5 compatible
@@ -32,37 +32,42 @@ Orion family
   Linux kernel plat directory:
 	arch/arm/plat-orion
 
+.. _MV88F5182-datasheet.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-datasheet.pdf
+.. _MV88F5182-opensource-manual.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-opensource-manual.pdf
+.. _MV88F5182-usermanual.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-usermanual.pdf
+.. _marvel_88f5281_data_sheet.pdf: http://www.ocmodshop.com/images/reviews/networking/qnap_ts409u/marvel_88f5281_data_sheet.pdf
+
 Kirkwood family
 ---------------
 
   Flavors:
         - 88F6282 a.k.a Armada 300
 
-                - Product Brief  : http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf
+                - Product Brief  : `armada_310.pdf`_
         - 88F6283 a.k.a Armada 310
 
-                - Product Brief  : http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf
+                - Product Brief  : `armada_310.pdf`_
         - 88F6190
 
-                - Product Brief  : http://www.marvell.com/embedded-processors/kirkwood/assets/88F6190-003_WEB.pdf
-                - Hardware Spec  : http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf
-                - Functional Spec: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
+                - Product Brief  : `88F6190-003_WEB.pdf`_
+                - Hardware Spec  : `HW_88F619x_OpenSource.pdf`_
+                - Functional Spec: `FS_88F6180_9x_6281_OpenSource.pdf`_
         - 88F6192
 
-                - Product Brief  : http://www.marvell.com/embedded-processors/kirkwood/assets/88F6192-003_ver1.pdf
-                - Hardware Spec  : http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf
-                - Functional Spec: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
+                - Product Brief  : `88F6192-003_ver1.pdf`_
+                - Hardware Spec  : `HW_88F619x_OpenSource.pdf`_
+                - Functional Spec: `FS_88F6180_9x_6281_OpenSource.pdf`_
         - 88F6182
         - 88F6180
 
-                - Product Brief  : http://www.marvell.com/embedded-processors/kirkwood/assets/88F6180-003_ver1.pdf
-                - Hardware Spec  : http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6180_OpenSource.pdf
-                - Functional Spec: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
+                - Product Brief  : `88F6180-003_ver1.pdf`_
+                - Hardware Spec  : `HW_88F6180_OpenSource.pdf`_
+                - Functional Spec: `FS_88F6180_9x_6281_OpenSource.pdf`_
         - 88F6281
 
-                - Product Brief  : http://www.marvell.com/embedded-processors/kirkwood/assets/88F6281-004_ver1.pdf
-                - Hardware Spec  : http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6281_OpenSource.pdf
-                - Functional Spec: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
+                - Product Brief  : `88F6281-004_ver1.pdf`_
+                - Hardware Spec  : `HW_88F6281_OpenSource.pdf`_
+                - Functional Spec: `FS_88F6180_9x_6281_OpenSource.pdf`_
   Homepage:
 	http://www.marvell.com/embedded-processors/kirkwood/
   Core:
@@ -72,20 +77,35 @@ Kirkwood family
   Linux kernel plat directory:
 	none
 
+.. _armada_310.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf
+.. _armada_310.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf
+.. _88F6190-003_WEB.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/88F6190-003_WEB.pdf
+.. _HW_88F619x_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf
+.. _FS_88F6180_9x_6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
+.. _88F6192-003_ver1.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/88F6192-003_ver1.pdf
+.. _HW_88F619x_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf
+.. _FS_88F6180_9x_6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
+.. _88F6180-003_ver1.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/88F6180-003_ver1.pdf
+.. _HW_88F6180_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6180_OpenSource.pdf
+.. _FS_88F6180_9x_6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
+.. _88F6281-004_ver1.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/88F6281-004_ver1.pdf
+.. _HW_88F6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6281_OpenSource.pdf
+.. _FS_88F6180_9x_6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
+
 Discovery family
 ----------------
 
   Flavors:
         - MV78100
 
-                - Product Brief  : http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78100-003_WEB.pdf
-                - Hardware Spec  : http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV78100_OpenSource.pdf
-                - Functional Spec: http://www.marvell.com/embedded-processors/discovery-innovation/assets/FS_MV76100_78100_78200_OpenSource.pdf
+                - Product Brief  : `MV78100-003_WEB.pdf`_
+                - Hardware Spec  : `HW_MV78100_OpenSource.pdf`_
+                - Functional Spec: `FS_MV76100_78100_78200_OpenSource.pdf`_
         - MV78200
 
-                - Product Brief  : http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78200-002_WEB.pdf
-                - Hardware Spec  : http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV78200_OpenSource.pdf
-                - Functional Spec: http://www.marvell.com/embedded-processors/discovery-innovation/assets/FS_MV76100_78100_78200_OpenSource.pdf
+                - Product Brief  : `MV78200-002_WEB.pdf`_
+                - Hardware Spec  : `HW_MV78200_OpenSource.pdf`_
+                - Functional Spec: `FS_MV76100_78100_78200_OpenSource.pdf`_
         - MV76100
 
                 Not supported by the Linux kernel.
@@ -98,6 +118,13 @@ Discovery family
   Linux kernel plat directory:
 	arch/arm/plat-orion
 
+.. _MV78100-003_WEB.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78100-003_WEB.pdf
+.. _HW_MV78100_OpenSource.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV78100_OpenSource.pdf
+.. _FS_MV76100_78100_78200_OpenSource.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/FS_MV76100_78100_78200_OpenSource.pdf
+.. _MV78200-002_WEB.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78200-002_WEB.pdf
+.. _HW_MV78200_OpenSource.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV78200_OpenSource.pdf
+.. _FS_MV76100_78100_78200_OpenSource.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/FS_MV76100_78100_78200_OpenSource.pdf
+
 EBU Armada family
 -----------------
 
@@ -106,9 +133,9 @@ EBU Armada family
         - 88F6707
         - 88F6W11
 
-    - Product Brief:   http://www.marvell.com/embedded-processors/armada-300/assets/Marvell_ARMADA_370_SoC.pdf
-    - Hardware Spec:   http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-datasheet.pdf
-    - Functional Spec: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-FunctionalSpec-datasheet.pdf
+    - Product Brief:   `Marvell_ARMADA_370_SoC.pdf`_
+    - Hardware Spec:   `ARMADA370-datasheet.pdf`_
+    - Functional Spec: `ARMADA370-FunctionalSpec-datasheet.pdf`_
 
   Core:
 	Sheeva ARMv7 compatible PJ4B
@@ -116,7 +143,7 @@ EBU Armada family
   Armada 375 Flavors:
 	- 88F6720
 
-    - Product Brief: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA_375_SoC-01_product_brief.pdf
+    - Product Brief: `ARMADA_375_SoC-01_product_brief.pdf`_
 
   Core:
 	ARM Cortex-A9
@@ -150,16 +177,16 @@ EBU Armada family
 	not to be confused with the non-SMP 78xx0 SoCs
 
     Product Brief:
-	http://www.marvell.com/embedded-processors/armada-xp/assets/Marvell-ArmadaXP-SoC-product%20brief.pdf
+	`Marvell-ArmadaXP-SoC-product%20brief.pdf`_
 
     Functional Spec:
-	http://www.marvell.com/embedded-processors/armada-xp/assets/ARMADA-XP-Functional-SpecDatasheet.pdf
+	`ARMADA-XP-Functional-SpecDatasheet.pdf`_
 
     - Hardware Specs:
 
-        - http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78230_OS.PDF
-        - http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78260_OS.PDF
-        - http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78460_OS.PDF
+        - `HW_MV78230_OS.PDF`_
+        - `HW_MV78260_OS.PDF`_
+        - `HW_MV78460_OS.PDF`_
 
   Core:
 	Sheeva ARMv7 compatible Dual-core or Quad-core PJ4B-MP
@@ -169,6 +196,16 @@ EBU Armada family
   Linux kernel plat directory:
 	none
 
+.. _Marvell_ARMADA_370_SoC.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/Marvell_ARMADA_370_SoC.pdf
+.. _ARMADA370-datasheet.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-datasheet.pdf
+.. _ARMADA370-FunctionalSpec-datasheet.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-FunctionalSpec-datasheet.pdf
+.. _ARMADA_375_SoC-01_product_brief.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA_375_SoC-01_product_brief.pdf
+.. _Marvell-ArmadaXP-SoC-product%20brief.pdf: http://www.marvell.com/embedded-processors/armada-xp/assets/Marvell-ArmadaXP-SoC-product%20brief.pdf
+.. _ARMADA-XP-Functional-SpecDatasheet.pdf: http://www.marvell.com/embedded-processors/armada-xp/assets/ARMADA-XP-Functional-SpecDatasheet.pdf
+.. _HW_MV78230_OS.PDF: http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78230_OS.PDF
+.. _HW_MV78260_OS.PDF: http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78260_OS.PDF
+.. _HW_MV78460_OS.PDF: http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78460_OS.PDF
+
 EBU Armada family ARMv8
 -----------------------
 
@@ -183,7 +220,7 @@ EBU Armada family ARMv8
 	http://www.marvell.com/embedded-processors/armada-3700/
 
   Product Brief:
-	http://www.marvell.com/embedded-processors/assets/PB-88F3700-FNL.pdf
+	`PB-88F3700-FNL.pdf`_
 
   Device tree files:
 	arch/arm64/boot/dts/marvell/armada-37*
@@ -198,8 +235,8 @@ EBU Armada family ARMv8
 	http://www.marvell.com/embedded-processors/armada-70xx/
 
   Product Brief:
-	  - http://www.marvell.com/embedded-processors/assets/Armada7020PB-Jan2016.pdf
-	  - http://www.marvell.com/embedded-processors/assets/Armada7040PB-Jan2016.pdf
+	  - `Armada7020PB-Jan2016.pdf`_
+	  - `Armada7040PB-Jan2016.pdf`_
 
   Device tree files:
 	arch/arm64/boot/dts/marvell/armada-70*
@@ -214,12 +251,18 @@ EBU Armada family ARMv8
 	http://www.marvell.com/embedded-processors/armada-80xx/
 
   Product Brief:
-	  - http://www.marvell.com/embedded-processors/assets/Armada8020PB-Jan2016.pdf
-	  - http://www.marvell.com/embedded-processors/assets/Armada8040PB-Jan2016.pdf
+	  - `Armada8020PB-Jan2016.pdf`_
+	  - `Armada8040PB-Jan2016.pdf`_
 
   Device tree files:
 	arch/arm64/boot/dts/marvell/armada-80*
 
+.. _PB-88F3700-FNL.pdf: http://www.marvell.com/embedded-processors/assets/PB-88F3700-FNL.pdf
+.. _Armada7020PB-Jan2016.pdf: http://www.marvell.com/embedded-processors/assets/Armada7020PB-Jan2016.pdf
+.. _Armada7040PB-Jan2016.pdf: http://www.marvell.com/embedded-processors/assets/Armada7040PB-Jan2016.pdf
+.. _Armada8020PB-Jan2016.pdf: http://www.marvell.com/embedded-processors/assets/Armada8020PB-Jan2016.pdf
+.. _Armada8040PB-Jan2016.pdf: http://www.marvell.com/embedded-processors/assets/Armada8040PB-Jan2016.pdf
+
 Avanta family
 -------------
 
@@ -233,7 +276,7 @@ Avanta family
 	http://www.marvell.com/broadband/
 
   Product Brief:
-	http://www.marvell.com/broadband/assets/Marvell_Avanta_88F6510_305_060-001_product_brief.pdf
+	`Marvell_Avanta_88F6510_305_060-001_product_brief.pdf`_
 
   No public datasheet available.
 
@@ -245,6 +288,8 @@ Avanta family
   Linux kernel plat directory:
 	no code in mainline yet, planned for the future
 
+.. _Marvell_Avanta_88F6510_305_060-001_product_brief.pdf: http://www.marvell.com/broadband/assets/Marvell_Avanta_88F6510_305_060-001_product_brief.pdf
+
 Storage family
 --------------
 
@@ -266,13 +311,13 @@ Dove family (application processor)
         - 88AP510 a.k.a Armada 510
 
    Product Brief:
-	http://www.marvell.com/application-processors/armada-500/assets/Marvell_Armada510_SoC.pdf
+	`Marvell_Armada510_SoC.pdf`_
 
    Hardware Spec:
-	http://www.marvell.com/application-processors/armada-500/assets/Armada-510-Hardware-Spec.pdf
+	`Armada-510-Hardware-Spec.pdf`_
 
   Functional Spec:
-	http://www.marvell.com/application-processors/armada-500/assets/Armada-510-Functional-Spec.pdf
+	`Armada-510-Functional-Spec.pdf`_
 
   Homepage:
 	http://www.marvell.com/application-processors/armada-500/
@@ -284,6 +329,10 @@ Dove family (application processor)
 	- arch/arm/mach-mvebu (DT enabled platforms)
         - arch/arm/mach-dove (non-DT enabled platforms)
 
+.. _Marvell_Armada510_SoC.pdf: http://www.marvell.com/application-processors/armada-500/assets/Marvell_Armada510_SoC.pdf
+.. _Armada-510-Hardware-Spec.pdf: http://www.marvell.com/application-processors/armada-500/assets/Armada-510-Hardware-Spec.pdf
+.. _Armada-510-Functional-Spec.pdf: http://www.marvell.com/application-processors/armada-500/assets/Armada-510-Functional-Spec.pdf
+
 PXA 2xx/3xx/93x/95x family
 --------------------------
 
@@ -292,22 +341,22 @@ PXA 2xx/3xx/93x/95x family
              - Application processor only
              - Core: ARMv5 XScale1 core
         - PXA270, PXA271, PXA272
-             - Product Brief         : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_pb.pdf
-             - Design guide          : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_design_guide.pdf
-             - Developers manual     : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_dev_man.pdf
-             - Specification         : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_emts.pdf
-             - Specification update  : http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_spec_update.pdf
+             - Product Brief         : `pxa_27x_pb.pdf`_
+             - Design guide          : `pxa_27x_design_guide.pdf`_
+             - Developers manual     : `pxa_27x_dev_man.pdf`_
+             - Specification         : `pxa_27x_emts.pdf`_
+             - Specification update  : `pxa_27x_spec_update.pdf`_
              - Application processor only
              - Core: ARMv5 XScale2 core
         - PXA300, PXA310, PXA320
-             - PXA 300 Product Brief : http://www.marvell.com/application-processors/pxa-family/assets/PXA300_PB_R4.pdf
-             - PXA 310 Product Brief : http://www.marvell.com/application-processors/pxa-family/assets/PXA310_PB_R4.pdf
-             - PXA 320 Product Brief : http://www.marvell.com/application-processors/pxa-family/assets/PXA320_PB_R4.pdf
-             - Design guide          : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Design_Guide.pdf
-             - Developers manual     : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Developers_Manual.zip
-             - Specifications        : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_EMTS.pdf
-             - Specification Update  : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Spec_Update.zip
-             - Reference Manual      : http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_TavorP_BootROM_Ref_Manual.pdf
+             - PXA 300 Product Brief : `PXA300_PB_R4.pdf`_
+             - PXA 310 Product Brief : `PXA310_PB_R4.pdf`_
+             - PXA 320 Product Brief : `PXA320_PB_R4.pdf`_
+             - Design guide          : `PXA3xx_Design_Guide.pdf`_
+             - Developers manual     : `PXA3xx_Developers_Manual.zip`_
+             - Specifications        : `PXA3xx_EMTS.pdf`_
+             - Specification Update  : `PXA3xx_Spec_Update.zip`_
+             - Reference Manual      : `PXA3xx_TavorP_BootROM_Ref_Manual.pdf`_
              - Application processor only
              - Core: ARMv5 XScale3 core
         - PXA930, PXA935
@@ -333,31 +382,45 @@ PXA 2xx/3xx/93x/95x family
    Linux kernel plat directory:
 	arch/arm/plat-pxa
 
+.. _pxa_27x_pb.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_pb.pdf
+.. _pxa_27x_design_guide.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_design_guide.pdf
+.. _pxa_27x_dev_man.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_dev_man.pdf
+.. _pxa_27x_emts.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_emts.pdf
+.. _pxa_27x_spec_update.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_spec_update.pdf
+.. _PXA300_PB_R4.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA300_PB_R4.pdf
+.. _PXA310_PB_R4.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA310_PB_R4.pdf
+.. _PXA320_PB_R4.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA320_PB_R4.pdf
+.. _PXA3xx_Design_Guide.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Design_Guide.pdf
+.. _PXA3xx_Developers_Manual.zip: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Developers_Manual.zip
+.. _PXA3xx_EMTS.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_EMTS.pdf
+.. _PXA3xx_Spec_Update.zip: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Spec_Update.zip
+.. _PXA3xx_TavorP_BootROM_Ref_Manual.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_TavorP_BootROM_Ref_Manual.pdf
+
 MMP/MMP2/MMP3 family (communication processor)
 ----------------------------------------------
 
    Flavors:
         - PXA168, a.k.a Armada 168
-             - Homepage             : http://www.marvell.com/application-processors/armada-100/armada-168.jsp
-             - Product brief        : http://www.marvell.com/application-processors/armada-100/assets/pxa_168_pb.pdf
-             - Hardware manual      : http://www.marvell.com/application-processors/armada-100/assets/armada_16x_datasheet.pdf
-             - Software manual      : http://www.marvell.com/application-processors/armada-100/assets/armada_16x_software_manual.pdf
-             - Specification update : http://www.marvell.com/application-processors/armada-100/assets/ARMADA16x_Spec_update.pdf
-             - Boot ROM manual      : http://www.marvell.com/application-processors/armada-100/assets/armada_16x_ref_manual.pdf
-             - App node package     : http://www.marvell.com/application-processors/armada-100/assets/armada_16x_app_note_package.pdf
+             - Homepage             : `armada-168.jsp`_
+             - Product brief        : `pxa_168_pb.pdf`_
+             - Hardware manual      : `armada_16x_datasheet.pdf`_
+             - Software manual      : `armada_16x_software_manual.pdf`_
+             - Specification update : `ARMADA16x_Spec_update.pdf`_
+             - Boot ROM manual      : `armada_16x_ref_manual.pdf`_
+             - App node package     : `armada_16x_app_note_package.pdf`_
              - Application processor only
              - Core: ARMv5 compatible Marvell PJ1 88sv331 (Mohawk)
         - PXA910/PXA920
              - Homepage             : http://www.marvell.com/communication-processors/pxa910/
-             - Product Brief        : http://www.marvell.com/communication-processors/pxa910/assets/Marvell_PXA910_Platform-001_PB_final.pdf
+             - Product Brief        : `Marvell_PXA910_Platform-001_PB_final.pdf`_
              - Application processor with Communication processor
              - Core: ARMv5 compatible Marvell PJ1 88sv331 (Mohawk)
         - PXA688, a.k.a. MMP2, a.k.a Armada 610
-             - Product Brief        : http://www.marvell.com/application-processors/armada-600/assets/armada610_pb.pdf
+             - Product Brief        : `armada610_pb.pdf`_
              - Application processor only
              - Core: ARMv7 compatible Sheeva PJ4 88sv581x core
 	- PXA2128, a.k.a. MMP3 (OLPC XO4, Linux support not upstream)
-	     - Product Brief	  : http://www.marvell.com/application-processors/armada/pxa2128/assets/Marvell-ARMADA-PXA2128-SoC-PB.pdf
+	     - Product Brief	  : `Marvell-ARMADA-PXA2128-SoC-PB.pdf`_
 	     - Application processor only
 	     - Core: Dual-core ARMv7 compatible Sheeva PJ4C core
 	- PXA960/PXA968/PXA978 (Linux support not upstream)
@@ -388,13 +451,24 @@ MMP/MMP2/MMP3 family (communication processor)
    Linux kernel plat directory:
 	arch/arm/plat-pxa
 
+.. _armada-168.jsp: http://www.marvell.com/application-processors/armada-100/armada-168.jsp
+.. _pxa_168_pb.pdf: http://www.marvell.com/application-processors/armada-100/assets/pxa_168_pb.pdf
+.. _armada_16x_datasheet.pdf: http://www.marvell.com/application-processors/armada-100/assets/armada_16x_datasheet.pdf
+.. _armada_16x_software_manual.pdf: http://www.marvell.com/application-processors/armada-100/assets/armada_16x_software_manual.pdf
+.. _ARMADA16x_Spec_update.pdf: http://www.marvell.com/application-processors/armada-100/assets/ARMADA16x_Spec_update.pdf
+.. _armada_16x_ref_manual.pdf: http://www.marvell.com/application-processors/armada-100/assets/armada_16x_ref_manual.pdf
+.. _armada_16x_app_note_package.pdf: http://www.marvell.com/application-processors/armada-100/assets/armada_16x_app_note_package.pdf
+.. _Marvell_PXA910_Platform-001_PB_final.pdf: http://www.marvell.com/communication-processors/pxa910/assets/Marvell_PXA910_Platform-001_PB_final.pdf
+.. _armada610_pb.pdf: http://www.marvell.com/application-processors/armada-600/assets/armada610_pb.pdf
+.. _Marvell-ARMADA-PXA2128-SoC-PB.pdf: http://www.marvell.com/application-processors/armada/pxa2128/assets/Marvell-ARMADA-PXA2128-SoC-PB.pdf
+
 Berlin family (Multimedia Solutions)
 -------------------------------------
 
   - Flavors:
 	- 88DE3010, Armada 1000 (no Linux support)
 		- Core:		Marvell PJ1 (ARMv5TE), Dual-core
-		- Product Brief:	http://www.marvell.com.cn/digital-entertainment/assets/armada_1000_pb.pdf
+		- Product Brief:	`armada_1000_pb.pdf`_
 	- 88DE3005, Armada 1500 Mini
 		- Design name:	BG2CD
 		- Core:		ARM Cortex-A9, PL310 L2CC
@@ -414,6 +488,7 @@ Berlin family (Multimedia Solutions)
 		- Core:		ARM Cortex-A53
 
   Homepage: https://www.synaptics.com/products/multimedia-solutions
+
   Directory: arch/arm/mach-berlin
 
   Comments:
@@ -423,6 +498,8 @@ Berlin family (Multimedia Solutions)
 
    * The Berlin family was acquired by Synaptics from Marvell in 2017.
 
+.. _armada_1000_pb.pdf: http://www.marvell.com.cn/digital-entertainment/assets/armada_1000_pb.pdf
+
 CPU Cores
 ---------
 
-- 
2.29.2


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 2/5] docs: arm: marvell: drop some dead links
  2021-01-29 18:39 [PATCH 0/5] docs: arm: Improvements to Marvell SoC documentation Lubomir Rintel
  2021-01-29 18:39 ` [PATCH 1/5] docs: arm: marvell: turn the automatic links into labels Lubomir Rintel
@ 2021-01-29 18:39 ` Lubomir Rintel
  2021-01-29 18:39 ` [PATCH 3/5] docs: arm: marvell: replace stale links with archive links Lubomir Rintel
                   ` (2 subsequent siblings)
  4 siblings, 0 replies; 8+ messages in thread
From: Lubomir Rintel @ 2021-01-29 18:39 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Maen Suleiman, Lior Amsalem, Thomas Petazzoni, Andrew Lunn,
	Nicolas Pitre, Eric Miao, linux-doc, linux-kernel,
	Lubomir Rintel

Just remove these; there's good chance there wasn't anything useful
there anyway.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
---
 Documentation/arm/marvel.rst | 27 ++-------------------------
 1 file changed, 2 insertions(+), 25 deletions(-)

diff --git a/Documentation/arm/marvel.rst b/Documentation/arm/marvel.rst
index 716551f9b60a1..8577f8324f6c7 100644
--- a/Documentation/arm/marvel.rst
+++ b/Documentation/arm/marvel.rst
@@ -68,8 +68,6 @@ Kirkwood family
                 - Product Brief  : `88F6281-004_ver1.pdf`_
                 - Hardware Spec  : `HW_88F6281_OpenSource.pdf`_
                 - Functional Spec: `FS_88F6180_9x_6281_OpenSource.pdf`_
-  Homepage:
-	http://www.marvell.com/embedded-processors/kirkwood/
   Core:
 	Feroceon 88fr131 ARMv5 compatible
   Linux kernel mach directory:
@@ -153,8 +151,7 @@ EBU Armada family
 	- 88F6820 Armada 385
 	- 88F6828 Armada 388
 
-    - Product infos:   http://www.marvell.com/embedded-processors/armada-38x/
-    - Functional Spec: https://marvellcorp.wufoo.com/forms/marvell-armada-38x-functional-specifications/
+    - Functional Spec: `marvell-embedded-processors-armada-38x-functional-specifications-2015-11.pdf`_
 
   Core:
 	ARM Cortex-A9
@@ -163,8 +160,6 @@ EBU Armada family
 	- 88F6920 Armada 390
 	- 88F6928 Armada 398
 
-    - Product infos: http://www.marvell.com/embedded-processors/armada-39x/
-
   Core:
 	ARM Cortex-A9
 
@@ -200,6 +195,7 @@ EBU Armada family
 .. _ARMADA370-datasheet.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-datasheet.pdf
 .. _ARMADA370-FunctionalSpec-datasheet.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-FunctionalSpec-datasheet.pdf
 .. _ARMADA_375_SoC-01_product_brief.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA_375_SoC-01_product_brief.pdf
+.. _marvell-embedded-processors-armada-38x-functional-specifications-2015-11.pdf: https://www.marvell.com/content/dam/marvell/en/public-collateral/embedded-processors/marvell-embedded-processors-armada-38x-functional-specifications-2015-11.pdf
 .. _Marvell-ArmadaXP-SoC-product%20brief.pdf: http://www.marvell.com/embedded-processors/armada-xp/assets/Marvell-ArmadaXP-SoC-product%20brief.pdf
 .. _ARMADA-XP-Functional-SpecDatasheet.pdf: http://www.marvell.com/embedded-processors/armada-xp/assets/ARMADA-XP-Functional-SpecDatasheet.pdf
 .. _HW_MV78230_OS.PDF: http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78230_OS.PDF
@@ -216,9 +212,6 @@ EBU Armada family ARMv8
   Core:
 	ARM Cortex A53 (ARMv8)
 
-  Homepage:
-	http://www.marvell.com/embedded-processors/armada-3700/
-
   Product Brief:
 	`PB-88F3700-FNL.pdf`_
 
@@ -231,9 +224,6 @@ EBU Armada family ARMv8
 
   Core: ARM Cortex A72
 
-  Homepage:
-	http://www.marvell.com/embedded-processors/armada-70xx/
-
   Product Brief:
 	  - `Armada7020PB-Jan2016.pdf`_
 	  - `Armada7040PB-Jan2016.pdf`_
@@ -247,9 +237,6 @@ EBU Armada family ARMv8
   Core:
 	ARM Cortex A72
 
-  Homepage:
-	http://www.marvell.com/embedded-processors/armada-80xx/
-
   Product Brief:
 	  - `Armada8020PB-Jan2016.pdf`_
 	  - `Armada8040PB-Jan2016.pdf`_
@@ -272,9 +259,6 @@ Avanta family
        - 88F6550
        - 88F6560
 
-  Homepage:
-	http://www.marvell.com/broadband/
-
   Product Brief:
 	`Marvell_Avanta_88F6510_305_060-001_product_brief.pdf`_
 
@@ -296,9 +280,6 @@ Storage family
   Armada SP:
 	- 88RC1580
 
-  Product infos:
-	http://www.marvell.com/storage/armada-sp/
-
   Core:
 	Sheeva ARMv7 comatible Quad-core PJ4C
 
@@ -319,9 +300,6 @@ Dove family (application processor)
   Functional Spec:
 	`Armada-510-Functional-Spec.pdf`_
 
-  Homepage:
-	http://www.marvell.com/application-processors/armada-500/
-
   Core:
 	ARMv7 compatible
 
@@ -411,7 +389,6 @@ MMP/MMP2/MMP3 family (communication processor)
              - Application processor only
              - Core: ARMv5 compatible Marvell PJ1 88sv331 (Mohawk)
         - PXA910/PXA920
-             - Homepage             : http://www.marvell.com/communication-processors/pxa910/
              - Product Brief        : `Marvell_PXA910_Platform-001_PB_final.pdf`_
              - Application processor with Communication processor
              - Core: ARMv5 compatible Marvell PJ1 88sv331 (Mohawk)
-- 
2.29.2


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 3/5] docs: arm: marvell: replace stale links with archive links
  2021-01-29 18:39 [PATCH 0/5] docs: arm: Improvements to Marvell SoC documentation Lubomir Rintel
  2021-01-29 18:39 ` [PATCH 1/5] docs: arm: marvell: turn the automatic links into labels Lubomir Rintel
  2021-01-29 18:39 ` [PATCH 2/5] docs: arm: marvell: drop some dead links Lubomir Rintel
@ 2021-01-29 18:39 ` Lubomir Rintel
  2021-01-29 18:39 ` [PATCH 4/5] docs: arm: marvell: clarify some unimportant Armada 6x0 details Lubomir Rintel
  2021-01-29 18:39 ` [PATCH 5/5] docs: arm: marvell: rename marvel.rst to marvell.rst Lubomir Rintel
  4 siblings, 0 replies; 8+ messages in thread
From: Lubomir Rintel @ 2021-01-29 18:39 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Maen Suleiman, Lior Amsalem, Thomas Petazzoni, Andrew Lunn,
	Nicolas Pitre, Eric Miao, linux-doc, linux-kernel,
	Lubomir Rintel

Marvell has an annoying habit of moving stuff around their web site
every full moon, and often just removing documents altogether.

At this point basically none but four of the links still works and even
those that work today weren't working for a long period of time
previously. That is a shame because (short of the product briefs) the
documents tend to be quite useful.

Let's replace them with known working versions of IA's Wayback Machine
links. That seems to be about the only way of getting a URL that's going
to work the next week.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
---
 Documentation/arm/marvel.rst | 76 ++++++++++++++++++------------------
 1 file changed, 38 insertions(+), 38 deletions(-)

diff --git a/Documentation/arm/marvel.rst b/Documentation/arm/marvel.rst
index 8577f8324f6c7..0c291d1091f1d 100644
--- a/Documentation/arm/marvel.rst
+++ b/Documentation/arm/marvel.rst
@@ -32,10 +32,10 @@ Orion family
   Linux kernel plat directory:
 	arch/arm/plat-orion
 
-.. _MV88F5182-datasheet.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-datasheet.pdf
-.. _MV88F5182-opensource-manual.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-opensource-manual.pdf
-.. _MV88F5182-usermanual.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-usermanual.pdf
-.. _marvel_88f5281_data_sheet.pdf: http://www.ocmodshop.com/images/reviews/networking/qnap_ts409u/marvel_88f5281_data_sheet.pdf
+.. _MV88F5182-datasheet.pdf: http://web.archive.org/web/20210124231420/http://csclub.uwaterloo.ca/~board/ts7800/MV88F5182-datasheet.pdf
+.. _MV88F5182-opensource-manual.pdf: http://web.archive.org/web/20210124231536/http://csclub.uwaterloo.ca/~board/ts7800/MV88F5182-opensource-manual.pdf
+.. _MV88F5182-usermanual.pdf: http://web.archive.org/web/20210124231631/http://csclub.uwaterloo.ca/~board/ts7800/MV88F5182-usermanual.pdf
+.. _marvel_88f5281_data_sheet.pdf: http://web.archive.org/web/20131028144728/http://www.ocmodshop.com/images/reviews/networking/qnap_ts409u/marvel_88f5281_data_sheet.pdf
 
 Kirkwood family
 ---------------
@@ -75,18 +75,18 @@ Kirkwood family
   Linux kernel plat directory:
 	none
 
-.. _armada_310.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf
-.. _armada_310.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf
+.. _armada_310.pdf: http://web.archive.org/web/20111027032509/http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf
+.. _armada_310.pdf: http://web.archive.org/web/20111027032509/http://www.marvell.com/embedded-processors/armada-300/assets/armada_310.pdf
 .. _88F6190-003_WEB.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/88F6190-003_WEB.pdf
-.. _HW_88F619x_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf
+.. _HW_88F619x_OpenSource.pdf: http://web.archive.org/web/20121021182835/http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf
 .. _FS_88F6180_9x_6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
-.. _88F6192-003_ver1.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/88F6192-003_ver1.pdf
-.. _HW_88F619x_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf
+.. _88F6192-003_ver1.pdf: http://web.archive.org/web/20131113121446/http://www.marvell.com/embedded-processors/kirkwood/assets/88F6192-003_ver1.pdf
+.. _HW_88F619x_OpenSource.pdf: http://web.archive.org/web/20121021182835/http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F619x_OpenSource.pdf
 .. _FS_88F6180_9x_6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
 .. _88F6180-003_ver1.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/88F6180-003_ver1.pdf
 .. _HW_88F6180_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6180_OpenSource.pdf
 .. _FS_88F6180_9x_6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
-.. _88F6281-004_ver1.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/88F6281-004_ver1.pdf
+.. _88F6281-004_ver1.pdf: http://web.archive.org/web/20120131133709/http://www.marvell.com/embedded-processors/kirkwood/assets/88F6281-004_ver1.pdf
 .. _HW_88F6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/HW_88F6281_OpenSource.pdf
 .. _FS_88F6180_9x_6281_OpenSource.pdf: http://www.marvell.com/embedded-processors/kirkwood/assets/FS_88F6180_9x_6281_OpenSource.pdf
 
@@ -116,10 +116,10 @@ Discovery family
   Linux kernel plat directory:
 	arch/arm/plat-orion
 
-.. _MV78100-003_WEB.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78100-003_WEB.pdf
-.. _HW_MV78100_OpenSource.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV78100_OpenSource.pdf
+.. _MV78100-003_WEB.pdf: http://web.archive.org/web/20120616194711/http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78100-003_WEB.pdf
+.. _HW_MV78100_OpenSource.pdf: http://web.archive.org/web/20141005120451/http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV78100_OpenSource.pdf
 .. _FS_MV76100_78100_78200_OpenSource.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/FS_MV76100_78100_78200_OpenSource.pdf
-.. _MV78200-002_WEB.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78200-002_WEB.pdf
+.. _MV78200-002_WEB.pdf: http://web.archive.org/web/20140801121623/http://www.marvell.com/embedded-processors/discovery-innovation/assets/MV78200-002_WEB.pdf
 .. _HW_MV78200_OpenSource.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/HW_MV78200_OpenSource.pdf
 .. _FS_MV76100_78100_78200_OpenSource.pdf: http://www.marvell.com/embedded-processors/discovery-innovation/assets/FS_MV76100_78100_78200_OpenSource.pdf
 
@@ -191,16 +191,16 @@ EBU Armada family
   Linux kernel plat directory:
 	none
 
-.. _Marvell_ARMADA_370_SoC.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/Marvell_ARMADA_370_SoC.pdf
+.. _Marvell_ARMADA_370_SoC.pdf: http://web.archive.org/web/20121115063038/http://www.marvell.com/embedded-processors/armada-300/assets/Marvell_ARMADA_370_SoC.pdf
 .. _ARMADA370-datasheet.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-datasheet.pdf
 .. _ARMADA370-FunctionalSpec-datasheet.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-FunctionalSpec-datasheet.pdf
-.. _ARMADA_375_SoC-01_product_brief.pdf: http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA_375_SoC-01_product_brief.pdf
-.. _marvell-embedded-processors-armada-38x-functional-specifications-2015-11.pdf: https://www.marvell.com/content/dam/marvell/en/public-collateral/embedded-processors/marvell-embedded-processors-armada-38x-functional-specifications-2015-11.pdf
-.. _Marvell-ArmadaXP-SoC-product%20brief.pdf: http://www.marvell.com/embedded-processors/armada-xp/assets/Marvell-ArmadaXP-SoC-product%20brief.pdf
+.. _ARMADA_375_SoC-01_product_brief.pdf: http://web.archive.org/web/20131216023516/http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA_375_SoC-01_product_brief.pdf
+.. _marvell-embedded-processors-armada-38x-functional-specifications-2015-11.pdf: http://web.archive.org/web/20200420191927/https://www.marvell.com/content/dam/marvell/en/public-collateral/embedded-processors/marvell-embedded-processors-armada-38x-functional-specifications-2015-11.pdf
+.. _Marvell-ArmadaXP-SoC-product%20brief.pdf: http://web.archive.org/web/20121021173528/http://www.marvell.com/embedded-processors/armada-xp/assets/Marvell-ArmadaXP-SoC-product%20brief.pdf
 .. _ARMADA-XP-Functional-SpecDatasheet.pdf: http://www.marvell.com/embedded-processors/armada-xp/assets/ARMADA-XP-Functional-SpecDatasheet.pdf
-.. _HW_MV78230_OS.PDF: http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78230_OS.PDF
+.. _HW_MV78230_OS.PDF: http://web.archive.org/web/20141127013651/http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78230_OS.PDF
 .. _HW_MV78260_OS.PDF: http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78260_OS.PDF
-.. _HW_MV78460_OS.PDF: http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78460_OS.PDF
+.. _HW_MV78460_OS.PDF: http://web.archive.org/web/20141222000230/http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78460_OS.PDF
 
 EBU Armada family ARMv8
 -----------------------
@@ -244,10 +244,10 @@ EBU Armada family ARMv8
   Device tree files:
 	arch/arm64/boot/dts/marvell/armada-80*
 
-.. _PB-88F3700-FNL.pdf: http://www.marvell.com/embedded-processors/assets/PB-88F3700-FNL.pdf
-.. _Armada7020PB-Jan2016.pdf: http://www.marvell.com/embedded-processors/assets/Armada7020PB-Jan2016.pdf
-.. _Armada7040PB-Jan2016.pdf: http://www.marvell.com/embedded-processors/assets/Armada7040PB-Jan2016.pdf
-.. _Armada8020PB-Jan2016.pdf: http://www.marvell.com/embedded-processors/assets/Armada8020PB-Jan2016.pdf
+.. _PB-88F3700-FNL.pdf: http://web.archive.org/web/20160309224849/http://www.marvell.com/embedded-processors/assets/PB-88F3700-FNL.pdf
+.. _Armada7020PB-Jan2016.pdf: http://web.archive.org/web/20161010105541/http://www.marvell.com/embedded-processors/assets/Armada7020PB-Jan2016.pdf
+.. _Armada7040PB-Jan2016.pdf: http://web.archive.org/web/20160928154533/http://www.marvell.com/embedded-processors/assets/Armada7040PB-Jan2016.pdf
+.. _Armada8020PB-Jan2016.pdf: https://web.archive.org/web/20210124233728/https://www.marvell.com/content/dam/marvell/en/public-collateral/embedded-processors/marvell-embedded-processors-armada-8020-product-brief-2017-12.pdf
 .. _Armada8040PB-Jan2016.pdf: http://www.marvell.com/embedded-processors/assets/Armada8040PB-Jan2016.pdf
 
 Avanta family
@@ -272,7 +272,7 @@ Avanta family
   Linux kernel plat directory:
 	no code in mainline yet, planned for the future
 
-.. _Marvell_Avanta_88F6510_305_060-001_product_brief.pdf: http://www.marvell.com/broadband/assets/Marvell_Avanta_88F6510_305_060-001_product_brief.pdf
+.. _Marvell_Avanta_88F6510_305_060-001_product_brief.pdf: http://web.archive.org/web/20180829171057/http://www.marvell.com/broadband/assets/Marvell_Avanta_88F6510_305_060-001_product_brief.pdf
 
 Storage family
 --------------
@@ -307,9 +307,9 @@ Dove family (application processor)
 	- arch/arm/mach-mvebu (DT enabled platforms)
         - arch/arm/mach-dove (non-DT enabled platforms)
 
-.. _Marvell_Armada510_SoC.pdf: http://www.marvell.com/application-processors/armada-500/assets/Marvell_Armada510_SoC.pdf
+.. _Marvell_Armada510_SoC.pdf: http://web.archive.org/web/20111102020643/http://www.marvell.com/application-processors/armada-500/assets/Marvell_Armada510_SoC.pdf
 .. _Armada-510-Hardware-Spec.pdf: http://www.marvell.com/application-processors/armada-500/assets/Armada-510-Hardware-Spec.pdf
-.. _Armada-510-Functional-Spec.pdf: http://www.marvell.com/application-processors/armada-500/assets/Armada-510-Functional-Spec.pdf
+.. _Armada-510-Functional-Spec.pdf: http://web.archive.org/web/20120130172443/http://www.marvell.com/application-processors/armada-500/assets/Armada-510-Functional-Spec.pdf
 
 PXA 2xx/3xx/93x/95x family
 --------------------------
@@ -360,19 +360,19 @@ PXA 2xx/3xx/93x/95x family
    Linux kernel plat directory:
 	arch/arm/plat-pxa
 
-.. _pxa_27x_pb.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_pb.pdf
-.. _pxa_27x_design_guide.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_design_guide.pdf
-.. _pxa_27x_dev_man.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_dev_man.pdf
+.. _pxa_27x_pb.pdf: http://web.archive.org/web/20150927135510/http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_pb.pdf
+.. _pxa_27x_design_guide.pdf: http://web.archive.org/web/20120111181937/http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_design_guide.pdf
+.. _pxa_27x_dev_man.pdf: http://web.archive.org/web/20150927164805/http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_dev_man.pdf
 .. _pxa_27x_emts.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_emts.pdf
 .. _pxa_27x_spec_update.pdf: http://www.marvell.com/application-processors/pxa-family/assets/pxa_27x_spec_update.pdf
-.. _PXA300_PB_R4.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA300_PB_R4.pdf
+.. _PXA300_PB_R4.pdf: http://web.archive.org/web/20120111121203/http://www.marvell.com/application-processors/pxa-family/assets/PXA300_PB_R4.pdf
 .. _PXA310_PB_R4.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA310_PB_R4.pdf
-.. _PXA320_PB_R4.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA320_PB_R4.pdf
+.. _PXA320_PB_R4.pdf: http://web.archive.org/web/20121021182826/http://www.marvell.com/application-processors/pxa-family/assets/PXA320_PB_R4.pdf
 .. _PXA3xx_Design_Guide.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Design_Guide.pdf
-.. _PXA3xx_Developers_Manual.zip: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Developers_Manual.zip
+.. _PXA3xx_Developers_Manual.zip: http://web.archive.org/web/20130727144605/http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Developers_Manual.zip
 .. _PXA3xx_EMTS.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_EMTS.pdf
 .. _PXA3xx_Spec_Update.zip: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_Spec_Update.zip
-.. _PXA3xx_TavorP_BootROM_Ref_Manual.pdf: http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_TavorP_BootROM_Ref_Manual.pdf
+.. _PXA3xx_TavorP_BootROM_Ref_Manual.pdf: http://web.archive.org/web/20120111103844/http://www.marvell.com/application-processors/pxa-family/assets/PXA3xx_TavorP_BootROM_Ref_Manual.pdf
 
 MMP/MMP2/MMP3 family (communication processor)
 ----------------------------------------------
@@ -429,13 +429,13 @@ MMP/MMP2/MMP3 family (communication processor)
 	arch/arm/plat-pxa
 
 .. _armada-168.jsp: http://www.marvell.com/application-processors/armada-100/armada-168.jsp
-.. _pxa_168_pb.pdf: http://www.marvell.com/application-processors/armada-100/assets/pxa_168_pb.pdf
+.. _pxa_168_pb.pdf: http://web.archive.org/web/20111102030100/http://www.marvell.com/application-processors/armada-100/assets/pxa_168_pb.pdf
 .. _armada_16x_datasheet.pdf: http://www.marvell.com/application-processors/armada-100/assets/armada_16x_datasheet.pdf
-.. _armada_16x_software_manual.pdf: http://www.marvell.com/application-processors/armada-100/assets/armada_16x_software_manual.pdf
+.. _armada_16x_software_manual.pdf: http://web.archive.org/web/20160428154454/http://www.marvell.com/application-processors/armada-100/assets/armada_16x_software_manual.pdf
 .. _ARMADA16x_Spec_update.pdf: http://www.marvell.com/application-processors/armada-100/assets/ARMADA16x_Spec_update.pdf
-.. _armada_16x_ref_manual.pdf: http://www.marvell.com/application-processors/armada-100/assets/armada_16x_ref_manual.pdf
-.. _armada_16x_app_note_package.pdf: http://www.marvell.com/application-processors/armada-100/assets/armada_16x_app_note_package.pdf
-.. _Marvell_PXA910_Platform-001_PB_final.pdf: http://www.marvell.com/communication-processors/pxa910/assets/Marvell_PXA910_Platform-001_PB_final.pdf
+.. _armada_16x_ref_manual.pdf: http://web.archive.org/web/20130727205559/http://www.marvell.com/application-processors/armada-100/assets/armada_16x_ref_manual.pdf
+.. _armada_16x_app_note_package.pdf: http://web.archive.org/web/20141005090706/http://www.marvell.com/application-processors/armada-100/assets/armada_16x_app_note_package.pdf
+.. _Marvell_PXA910_Platform-001_PB_final.pdf: https://archive.org/download/marvell-pxa910-pb/Marvell_PXA910_Platform-001_PB.pdf
 .. _armada610_pb.pdf: http://www.marvell.com/application-processors/armada-600/assets/armada610_pb.pdf
 .. _Marvell-ARMADA-PXA2128-SoC-PB.pdf: http://www.marvell.com/application-processors/armada/pxa2128/assets/Marvell-ARMADA-PXA2128-SoC-PB.pdf
 
-- 
2.29.2


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 4/5] docs: arm: marvell: clarify some unimportant Armada 6x0 details
  2021-01-29 18:39 [PATCH 0/5] docs: arm: Improvements to Marvell SoC documentation Lubomir Rintel
                   ` (2 preceding siblings ...)
  2021-01-29 18:39 ` [PATCH 3/5] docs: arm: marvell: replace stale links with archive links Lubomir Rintel
@ 2021-01-29 18:39 ` Lubomir Rintel
  2021-01-29 18:39 ` [PATCH 5/5] docs: arm: marvell: rename marvel.rst to marvell.rst Lubomir Rintel
  4 siblings, 0 replies; 8+ messages in thread
From: Lubomir Rintel @ 2021-01-29 18:39 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Maen Suleiman, Lior Amsalem, Thomas Petazzoni, Andrew Lunn,
	Nicolas Pitre, Eric Miao, linux-doc, linux-kernel,
	Lubomir Rintel

MMP2 is used in XO-1.75 and MMP3 is now supported in mainline.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
---
 Documentation/arm/marvel.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/arm/marvel.rst b/Documentation/arm/marvel.rst
index 0c291d1091f1d..43f2fe407796e 100644
--- a/Documentation/arm/marvel.rst
+++ b/Documentation/arm/marvel.rst
@@ -392,11 +392,11 @@ MMP/MMP2/MMP3 family (communication processor)
              - Product Brief        : `Marvell_PXA910_Platform-001_PB_final.pdf`_
              - Application processor with Communication processor
              - Core: ARMv5 compatible Marvell PJ1 88sv331 (Mohawk)
-        - PXA688, a.k.a. MMP2, a.k.a Armada 610
+        - PXA688, a.k.a. MMP2, a.k.a Armada 610 (OLPC XO-1.75)
              - Product Brief        : `armada610_pb.pdf`_
              - Application processor only
              - Core: ARMv7 compatible Sheeva PJ4 88sv581x core
-	- PXA2128, a.k.a. MMP3 (OLPC XO4, Linux support not upstream)
+	- PXA2128, a.k.a. MMP3, a.k.a Armada 620 (OLPC XO-4)
 	     - Product Brief	  : `Marvell-ARMADA-PXA2128-SoC-PB.pdf`_
 	     - Application processor only
 	     - Core: Dual-core ARMv7 compatible Sheeva PJ4C core
-- 
2.29.2


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 5/5] docs: arm: marvell: rename marvel.rst to marvell.rst
  2021-01-29 18:39 [PATCH 0/5] docs: arm: Improvements to Marvell SoC documentation Lubomir Rintel
                   ` (3 preceding siblings ...)
  2021-01-29 18:39 ` [PATCH 4/5] docs: arm: marvell: clarify some unimportant Armada 6x0 details Lubomir Rintel
@ 2021-01-29 18:39 ` Lubomir Rintel
  4 siblings, 0 replies; 8+ messages in thread
From: Lubomir Rintel @ 2021-01-29 18:39 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Maen Suleiman, Lior Amsalem, Thomas Petazzoni, Andrew Lunn,
	Nicolas Pitre, Eric Miao, linux-doc, linux-kernel,
	Lubomir Rintel

This company is not the superheroes you're looking for.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
---
 Documentation/arm/{marvel.rst => marvell.rst} | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename Documentation/arm/{marvel.rst => marvell.rst} (100%)

diff --git a/Documentation/arm/marvel.rst b/Documentation/arm/marvell.rst
similarity index 100%
rename from Documentation/arm/marvel.rst
rename to Documentation/arm/marvell.rst
-- 
2.29.2


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/5] docs: arm: marvell: turn the automatic links into labels
  2021-01-29 18:39 ` [PATCH 1/5] docs: arm: marvell: turn the automatic links into labels Lubomir Rintel
@ 2021-01-30  0:20   ` Jonathan Corbet
  2021-01-30 14:06     ` Lubomir Rintel
  0 siblings, 1 reply; 8+ messages in thread
From: Jonathan Corbet @ 2021-01-30  0:20 UTC (permalink / raw)
  To: Lubomir Rintel
  Cc: Maen Suleiman, Lior Amsalem, Thomas Petazzoni, Andrew Lunn,
	Nicolas Pitre, Eric Miao, linux-doc, linux-kernel,
	Lubomir Rintel

Lubomir Rintel <lkundrak@v3.sk> writes:

> Lines ending with obscenely long URLs at the end don't look good.
>
> Even if these links are not that long at this point, they will be when
> replaced with an archive link in a subsequent patch -- let's prepare for
> that.
>
> Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
> ---
>  Documentation/arm/marvel.rst | 209 ++++++++++++++++++++++++-----------
>  1 file changed, 143 insertions(+), 66 deletions(-)
>
> diff --git a/Documentation/arm/marvel.rst b/Documentation/arm/marvel.rst
> index 16ab2eb085b86..716551f9b60a1 100644
> --- a/Documentation/arm/marvel.rst
> +++ b/Documentation/arm/marvel.rst
> @@ -18,12 +18,12 @@ Orion family
>          - 88F5181L
>          - 88F5182
>  
> -               - Datasheet: http://www.embeddedarm.com/documentation/third-party/MV88F5182-datasheet.pdf
> -               - Programmer's User Guide: http://www.embeddedarm.com/documentation/third-party/MV88F5182-opensource-manual.pdf
> -               - User Manual: http://www.embeddedarm.com/documentation/third-party/MV88F5182-usermanual.pdf
> +               - Datasheet: `MV88F5182-datasheet.pdf`_
> +               - Programmer's User Guide: `MV88F5182-opensource-manual.pdf`_
> +               - User Manual: `MV88F5182-usermanual.pdf`_
>          - 88F5281
>  
> -               - Datasheet: http://www.ocmodshop.com/images/reviews/networking/qnap_ts409u/marvel_88f5281_data_sheet.pdf
> +               - Datasheet: `marvel_88f5281_data_sheet.pdf`_
>          - 88F6183
>    Core:
>  	Feroceon 88fr331 (88f51xx) or 88fr531-vd (88f52xx) ARMv5 compatible
> @@ -32,37 +32,42 @@ Orion family
>    Linux kernel plat directory:
>  	arch/arm/plat-orion
>  
> +.. _MV88F5182-datasheet.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-datasheet.pdf
> +.. _MV88F5182-opensource-manual.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-opensource-manual.pdf
> +.. _MV88F5182-usermanual.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-usermanual.pdf
> +.. _marvel_88f5281_data_sheet.pdf: http://www.ocmodshop.com/images/reviews/networking/qnap_ts409u/marvel_88f5281_data_sheet.pdf

So I see what you're trying to do, but this has the effect of prettying
up the processed docs at the expense of making the plain-text version
harder to read.  Somebody who wants to find one of these datasheets from
the plain-text version has to skip further down in the file, hoping that
they pick out the right one among a set of long, similar URLs.
Honestly, I think we may be better off leaving them as they are.
Failing that, the right thing to do is to keep the lines defining the
URL labels right next to where they are referenced.

See what I'm getting at?

Thanks,

jon

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 1/5] docs: arm: marvell: turn the automatic links into labels
  2021-01-30  0:20   ` Jonathan Corbet
@ 2021-01-30 14:06     ` Lubomir Rintel
  0 siblings, 0 replies; 8+ messages in thread
From: Lubomir Rintel @ 2021-01-30 14:06 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Maen Suleiman, Lior Amsalem, Thomas Petazzoni, Andrew Lunn,
	Nicolas Pitre, Eric Miao, linux-doc, linux-kernel

On Fri, Jan 29, 2021 at 05:20:28PM -0700, Jonathan Corbet wrote:
> Lubomir Rintel <lkundrak@v3.sk> writes:
> 
> > Lines ending with obscenely long URLs at the end don't look good.
> >
> > Even if these links are not that long at this point, they will be when
> > replaced with an archive link in a subsequent patch -- let's prepare for
> > that.
> >
> > Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
> > ---
> >  Documentation/arm/marvel.rst | 209 ++++++++++++++++++++++++-----------
> >  1 file changed, 143 insertions(+), 66 deletions(-)
> >
> > diff --git a/Documentation/arm/marvel.rst b/Documentation/arm/marvel.rst
> > index 16ab2eb085b86..716551f9b60a1 100644
> > --- a/Documentation/arm/marvel.rst
> > +++ b/Documentation/arm/marvel.rst
> > @@ -18,12 +18,12 @@ Orion family
> >          - 88F5181L
> >          - 88F5182
> >  
> > -               - Datasheet: http://www.embeddedarm.com/documentation/third-party/MV88F5182-datasheet.pdf
> > -               - Programmer's User Guide: http://www.embeddedarm.com/documentation/third-party/MV88F5182-opensource-manual.pdf
> > -               - User Manual: http://www.embeddedarm.com/documentation/third-party/MV88F5182-usermanual.pdf
> > +               - Datasheet: `MV88F5182-datasheet.pdf`_
> > +               - Programmer's User Guide: `MV88F5182-opensource-manual.pdf`_
> > +               - User Manual: `MV88F5182-usermanual.pdf`_
> >          - 88F5281
> >  
> > -               - Datasheet: http://www.ocmodshop.com/images/reviews/networking/qnap_ts409u/marvel_88f5281_data_sheet.pdf
> > +               - Datasheet: `marvel_88f5281_data_sheet.pdf`_
> >          - 88F6183
> >    Core:
> >  	Feroceon 88fr331 (88f51xx) or 88fr531-vd (88f52xx) ARMv5 compatible
> > @@ -32,37 +32,42 @@ Orion family
> >    Linux kernel plat directory:
> >  	arch/arm/plat-orion
> >  
> > +.. _MV88F5182-datasheet.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-datasheet.pdf
> > +.. _MV88F5182-opensource-manual.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-opensource-manual.pdf
> > +.. _MV88F5182-usermanual.pdf: http://www.embeddedarm.com/documentation/third-party/MV88F5182-usermanual.pdf
> > +.. _marvel_88f5281_data_sheet.pdf: http://www.ocmodshop.com/images/reviews/networking/qnap_ts409u/marvel_88f5281_data_sheet.pdf
> 
> So I see what you're trying to do, but this has the effect of prettying
> up the processed docs at the expense of making the plain-text version
> harder to read.  Somebody who wants to find one of these datasheets from
> the plain-text version has to skip further down in the file, hoping that
> they pick out the right one among a set of long, similar URLs.
> Honestly, I think we may be better off leaving them as they are.
> Failing that, the right thing to do is to keep the lines defining the
> URL labels right next to where they are referenced.
> 
> See what I'm getting at?

Yes. I've been considering the same, but concluded it's a still a better
idea to move the full URLs below because

1.) at this point the links are broken anyway and the basename is the
    only valuable part of the URL when looking for an actual document;
    and the basename stays in place
2.) the archive.org links that replace them in another patch are waaaay too
    long even for very large displays

However, even though I think this is perhaps marginally better, either
way works for me. Thus, unless you change your mind about it, I'll follow
up with a v2 that drops this patch and replaces the links in place.

Thank you
Lubo

> 
> Thanks,
> 
> jon

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2021-01-30 14:08 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-29 18:39 [PATCH 0/5] docs: arm: Improvements to Marvell SoC documentation Lubomir Rintel
2021-01-29 18:39 ` [PATCH 1/5] docs: arm: marvell: turn the automatic links into labels Lubomir Rintel
2021-01-30  0:20   ` Jonathan Corbet
2021-01-30 14:06     ` Lubomir Rintel
2021-01-29 18:39 ` [PATCH 2/5] docs: arm: marvell: drop some dead links Lubomir Rintel
2021-01-29 18:39 ` [PATCH 3/5] docs: arm: marvell: replace stale links with archive links Lubomir Rintel
2021-01-29 18:39 ` [PATCH 4/5] docs: arm: marvell: clarify some unimportant Armada 6x0 details Lubomir Rintel
2021-01-29 18:39 ` [PATCH 5/5] docs: arm: marvell: rename marvel.rst to marvell.rst Lubomir Rintel

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).