doc: Reformat RST content for Sphinx rendering
Some existing RST files contain formatting errors that will cause
Sphinx to generate warnings.
Change-Id: I714136d1ea5b645eaa55dd304fb56d5b5fd18ee1
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
diff --git a/docs/change-log.rst b/docs/change-log.rst
index 29de0ed..da967e4 100644
--- a/docs/change-log.rst
+++ b/docs/change-log.rst
@@ -1,8 +1,5 @@
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
+Change Log & Release Notes
+==========================
Please note that the Trusted Firmware-A Tests version follows the Trusted
Firmware-A version for simplicity. At any point in time, TF-A Tests version
@@ -10,11 +7,11 @@
Tests are not guaranteed to be compatible. This also means that a version
upgrade on the TF-A-Tests side might not necessarily introduce any new feature.
-Trusted Firmware-A Tests - version 2.2
-======================================
+Version 2.2
+-----------
New features
-------------
+^^^^^^^^^^^^
- A wide range of tests are made available in this release to help validate
the functionality of TF-A.
@@ -22,7 +19,7 @@
- Various improvements to test framework and test suite.
TFTF
-````
+~~~~
- Enhancement to xlat table library synchronous to TF-A code base.
@@ -74,18 +71,18 @@
and fix the conditional check of AMU Group0 counter value.
Secure partitions
-`````````````````
+~~~~~~~~~~~~~~~~~
A new Secure Partition Quark is introduced in this release.
Quark
-'''''''''
+~~~~~
The Quark test secure partition provided is a simple service which returns a
magic number. Further, a simple test is added to test if Quark is functional.
Issues resolved since last release
-----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Bug fix in libc memchr implementation.
@@ -97,18 +94,14 @@
corresponding tests are stable in this release.
Known issues and limitations
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The sections below list the known issues and limitations of each test image
provided in this repository. Unless and otherwise stated, issues and limitations
stated in previous release continue to exist in this release.
TFTF
-````
-
-Tests
-'''''
-
+~~~~
- Multicore spurious interrupt test is observed to have unstable behavior. As a
temporary solution, this test is skipped for AArch64 Juno configurations.
@@ -119,11 +112,11 @@
-Trusted Firmware-A Tests - version 2.1
-======================================
+Version 2.1
+-----------
New features
-------------
+^^^^^^^^^^^^
- Add initial support for testing Secure Partition Client Interface (SPCI)
and Secure Partition Run-Time (SPRT) standards.
@@ -139,7 +132,7 @@
- Various stability improvements, code refactoring and clean ups.
TFTF
-````
+~~~~
- Reorganize tests build infrastructure to allow the selection of a subset of
tests.
@@ -173,7 +166,7 @@
- `Arm Neoverse Reference Design N1 Edge (RD-N1-Edge)`_ FVP (experimental).
Secure partitions
-`````````````````
+~~~~~~~~~~~~~~~~~
We now have 3 Secure Partitions to test the SPM implementation in TF-A.
@@ -211,7 +204,7 @@
provides the same services but with different identifiers at the moment.
EL3 payload
-```````````
+~~~~~~~~~~~
- New platform ports:
@@ -220,7 +213,7 @@
- `Arm Neoverse Reference Design N1 Edge (RD-N1-Edge)`_ FVP (experimental).
Issues resolved since last release
-----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- The GICv2 spurious IRQ test is no longer Juno-specific. It is now only
GICv2-specific.
@@ -233,19 +226,19 @@
- Cactus-MM now successfully links with GNU toolchain 7.3.1.
Known issues and limitations
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The sections below lists the known issues and limitations of each test image
provided in this repository.
TFTF
-````
+~~~~
The TFTF test image might be conceptually sub-divided further in 2 parts: the
tests themselves, and the test framework they are based upon.
Test framework
-''''''''''''''
+~~~~~~~~~~~~~~
- Some stability issues.
@@ -285,7 +278,7 @@
It is only enabled on the primary CPU on the cold boot.
Tests
-'''''
+~~~~~
- Some tests are implemented for AArch64 only and are skipped on AArch32.
@@ -324,7 +317,7 @@
The root cause is unknown.
FWU images
-``````````
+~~~~~~~~~~
- The FWU tests do not work on the revC of the Base AEM FVP. They only work on
the revB.
@@ -333,7 +326,7 @@
is not a clean design and may cause confusion.
Test secure partitions (Cactus, Cactus-MM, Ivy)
-```````````````````````````````````````````````
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- This is experimental code. It's likely to change a lot as the secure
partition software architecture evolves.
@@ -341,7 +334,7 @@
- Supported on AArch64 FVP platform only.
All test images
-```````````````
+~~~~~~~~~~~~~~~
- TF-A Tests are derived from a fork of TF-A so:
@@ -376,16 +369,16 @@
all such direct reads of the ``CNTPCT_EL0`` register and replace them with a
call to ``syscounter_read()`` where appropriate.
-Trusted Firmware-A Tests - version 2.0
-======================================
+Version 2.0
+-----------
New features
-------------
+^^^^^^^^^^^^
This is the first public release of the Trusted Firmware-A Tests source code.
TFTF
-````
+~~~~
- Provides a baremetal test framework to exercise TF-A features through its
``SMC`` interface.
@@ -433,7 +426,7 @@
test results in non-volatile memory (e.g. flash).
FWU images
-``````````
+~~~~~~~~~~
- Provides example code to exercise the Firmware Update feature of TF-A.
@@ -442,12 +435,12 @@
to the TF-A BL1 image.
EL3 test payload
-````````````````
+~~~~~~~~~~~~~~~~
- Tests the ability of TF-A to load an EL3 payload.
Cactus test secure partition
-````````````````````````````
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Tests that TF-A has correctly setup the secure partition environment: it
should be allowed to perform cache maintenance operations, access floating
@@ -459,19 +452,19 @@
- Tests the ability of a secure partition to handle StandaloneMM requests.
Known issues and limitations
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The sections below lists the known issues and limitations of each test image
provided in this repository.
TFTF
-````
+~~~~
The TFTF test image might be conceptually sub-divided further in 2 parts: the
tests themselves, and the test framework they are based upon.
Test framework
-''''''''''''''
+~~~~~~~~~~~~~~
- Some stability issues.
@@ -507,7 +500,7 @@
not complete. As a result, there are still some TFTF files scattered around.
Tests
-'''''
+~~~~~
- Some tests are implemented for AArch64 only and are skipped on AArch32.
@@ -555,7 +548,7 @@
The root cause is unknown.
FWU images
-``````````
+~~~~~~~~~~
- The FWU tests do not work on the revC of the Base AEM FVP. They only work on
the revB.
@@ -564,7 +557,7 @@
is not a clean design and may cause confusion.
Cactus test secure partition
-````````````````````````````
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Cactus is experimental code. It's likely to change a lot as the secure
partition software architecture evolves.
@@ -574,7 +567,7 @@
- Cactus is supported on AArch64 FVP platform only.
All test images
-```````````````
+~~~~~~~~~~~~~~~
- TF-A Tests are derived from a fork of TF-A so:
diff --git a/docs/design.rst b/docs/design.rst
index 91815d0..4df620c 100644
--- a/docs/design.rst
+++ b/docs/design.rst
@@ -1,10 +1,5 @@
-Trusted Firmware-A Tests - Design
-=================================
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
+Design
+======
This document provides some details about the internals of the TF-A Tests
design. It is incomplete at the moment.
diff --git a/docs/implementing-tests.rst b/docs/implementing-tests.rst
index f7be284..3810c14 100644
--- a/docs/implementing-tests.rst
+++ b/docs/implementing-tests.rst
@@ -1,10 +1,5 @@
-How to implement tests
-======================
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
+Implementing Tests
+==================
This document aims at providing some pointers to help implementing new tests in
the TFTF image.
@@ -114,7 +109,7 @@
--------------
-*Copyright (c) 2018, Arm Limited. All rights reserved.*
+*Copyright (c) 2018-2019, Arm Limited. All rights reserved.*
.. _SMC Calling Convention: SMCCC_
.. _SMCCC: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf
diff --git a/docs/porting-guide.rst b/docs/porting-guide.rst
index 9759c98..ba9b9aa 100644
--- a/docs/porting-guide.rst
+++ b/docs/porting-guide.rst
@@ -1,12 +1,5 @@
-Trusted Firmware-A Tests - Porting Guide
-========================================
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
-
---------------
+Porting Guide
+=============
Introduction
------------
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 2e6f7ba..41d0ba7 100644
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -1,10 +1,5 @@
-Trusted Firmware-A Tests - User Guide
-=====================================
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
+User Guide
+==========
This document describes how to build the Trusted Firmware-A Tests (TF-A Tests)
and run them on a set of platforms. It assumes that the reader has previous