From f1e0f15262cf3f19bf2edd93a0d70d6903e2733c Mon Sep 17 00:00:00 2001
From: Paul Beesley <paul.beesley@arm.com>
Date: Wed, 25 Sep 2019 12:58:36 +0000
Subject: [PATCH] doc: Fix platform port inclusion
This patch:
- Adds any leftover platform ports that were not having their
documentation built (not in the index.rst table of contents)
- Corrects a handful of RST formatting errors that cause poor
rendering
- Reorders the list of platforms so that they are displayed
in alphabetical order
Change-Id: If8c135a822d581c3c5c4fca2936d501ccfd2e94c
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
---
docs/plat/hikey.rst | 10 +++++-----
docs/plat/hikey960.rst | 10 +++++-----
docs/plat/index.rst | 22 +++++++++++++---------
docs/plat/intel-agilex.rst | 1 +
docs/plat/intel-stratix10.rst | 1 +
docs/plat/poplar.rst | 12 ++++++------
6 files changed, 31 insertions(+), 25 deletions(-)
diff --git a/docs/plat/hikey.rst b/docs/plat/hikey.rst
index 74ff2f46c..372d38867 100644
--- a/docs/plat/hikey.rst
+++ b/docs/plat/hikey.rst
@@ -1,15 +1,15 @@
-Description
-===========
+HiKey
+=====
HiKey is one of 96boards. Hisilicon Kirin6220 processor is installed on HiKey.
More information are listed in `link`_.
How to build
-============
+------------
Code Locations
---------------
+~~~~~~~~~~~~~~
- Trusted Firmware-A:
`link <https://github.com/ARM-software/arm-trusted-firmware>`__
@@ -33,7 +33,7 @@ Code Locations
`link <https://github.com/96boards-hikey/atf-fastboot/tree/master>`__
Build Procedure
----------------
+~~~~~~~~~~~~~~~
- Fetch all the above repositories into local host.
Make all the repositories in the same ${BUILD\_PATH}.
diff --git a/docs/plat/hikey960.rst b/docs/plat/hikey960.rst
index 7ddb0b104..3d42a77c5 100644
--- a/docs/plat/hikey960.rst
+++ b/docs/plat/hikey960.rst
@@ -1,15 +1,15 @@
-Description
-===========
+HiKey960
+========
HiKey960 is one of 96boards. Hisilicon Hi3660 processor is installed on HiKey960.
More information are listed in `link`_.
How to build
-============
+------------
Code Locations
---------------
+~~~~~~~~~~~~~~
- Trusted Firmware-A:
`link <https://github.com/ARM-software/arm-trusted-firmware>`__
@@ -30,7 +30,7 @@ Code Locations
`link <https://git.linaro.org/uefi/uefi-tools.git>`__
Build Procedure
----------------
+~~~~~~~~~~~~~~~
- Fetch all the above 5 repositories into local host.
Make all the repositories in the same ${BUILD\_PATH}.
diff --git a/docs/plat/index.rst b/docs/plat/index.rst
index eaeee84f3..2695d4e81 100644
--- a/docs/plat/index.rst
+++ b/docs/plat/index.rst
@@ -7,24 +7,28 @@ Platform Ports
:numbered:
allwinner
- fvp_ve
- imx8
- imx8m
- intel-stratix10
- ls1043a
- marvell/index
meson-gxbb
meson-gxl
+ fvp_ve
+ hikey
+ hikey960
+ intel-agilex
+ intel-stratix10
+ marvell/index
mt8183
nvidia-tegra
+ warp7
+ imx8
+ imx8m
+ ls1043a
+ poplar
qemu
+ rpi3
rcar-gen3
rockchip
- rpi3
socionext-uniphier
- stm32mp1
synquacer
+ stm32mp1
ti-k3
- warp7
xilinx-versal
xilinx-zynqmp
diff --git a/docs/plat/intel-agilex.rst b/docs/plat/intel-agilex.rst
index 015a195a8..ff27b6b5f 100644
--- a/docs/plat/intel-agilex.rst
+++ b/docs/plat/intel-agilex.rst
@@ -67,6 +67,7 @@ Boot trace
----------
::
+
INFO: DDR: DRAM calibration success.
INFO: ECC is disabled.
NOTICE: BL2: v2.1(debug)
diff --git a/docs/plat/intel-stratix10.rst b/docs/plat/intel-stratix10.rst
index 77a45a478..7f8d18e03 100644
--- a/docs/plat/intel-stratix10.rst
+++ b/docs/plat/intel-stratix10.rst
@@ -67,6 +67,7 @@ Boot trace
----------
::
+
INFO: DDR: DRAM calibration success.
INFO: ECC is disabled.
INFO: Init HPS NOC's DDR Scheduler.
diff --git a/docs/plat/poplar.rst b/docs/plat/poplar.rst
index 5884ed945..215f55142 100644
--- a/docs/plat/poplar.rst
+++ b/docs/plat/poplar.rst
@@ -1,5 +1,5 @@
-Description
-===========
+Poplar
+======
Poplar is the first development board compliant with the 96Boards Enterprise
Edition TV Platform specification.
@@ -35,10 +35,10 @@ must happen prior to invoking Trusted Firmware-A:
l-loader --> Trusted Firmware-A --> u-boot
How to build
-============
+------------
Code Locations
---------------
+~~~~~~~~~~~~~~
- Trusted Firmware-A:
`link <https://github.com/ARM-software/arm-trusted-firmware>`__
@@ -50,7 +50,7 @@ Code Locations
`link <http://git.denx.de/u-boot.git>`__
Build Procedure
----------------
+~~~~~~~~~~~~~~~
- Fetch all the above 3 repositories into local host.
Make all the repositories in the same ${BUILD\_PATH}.
@@ -89,7 +89,7 @@ The system will boot into a u-boot shell which you can then use to write the
working firmware to eMMC.
Boot trace
-==========
+----------
::