From 83993177d9d34a3e6032b71147bde86d75704f4a Mon Sep 17 00:00:00 2001 From: Paul Beesley Date: Thu, 7 Mar 2019 15:53:44 +0000 Subject: [PATCH] doc: Normalise section numbering and headings Required work to make all documents sit at the correct levels within the document tree and any derived content like the table of contents and the categories in the sidebar. Change-Id: I4885fbe30864a87c8822ee67482b71fb46a8fbc6 Signed-off-by: Paul Beesley --- docs/components/romlib-design.rst | 3 --- docs/components/spd/index.rst | 1 - docs/components/spd/tlk-dispatcher.rst | 10 +++++----- docs/components/spd/trusty-dispatcher.rst | 4 ++-- docs/getting_started/image-terminology.rst | 3 --- docs/process/release-information.rst | 3 --- 6 files changed, 7 insertions(+), 17 deletions(-) diff --git a/docs/components/romlib-design.rst b/docs/components/romlib-design.rst index 41957214d..00dbf67c8 100644 --- a/docs/components/romlib-design.rst +++ b/docs/components/romlib-design.rst @@ -1,9 +1,6 @@ Library at ROM ============== -.. section-numbering:: - :suffix: . - .. contents:: This document provides an overview of the "library at ROM" implementation in diff --git a/docs/components/spd/index.rst b/docs/components/spd/index.rst index e03bfe33d..25d0124b1 100644 --- a/docs/components/spd/index.rst +++ b/docs/components/spd/index.rst @@ -4,7 +4,6 @@ Secure Payload Dispatcher (SPD) .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: optee-dispatcher tlk-dispatcher diff --git a/docs/components/spd/tlk-dispatcher.rst b/docs/components/spd/tlk-dispatcher.rst index 90af5faf6..a6c658cc4 100644 --- a/docs/components/spd/tlk-dispatcher.rst +++ b/docs/components/spd/tlk-dispatcher.rst @@ -15,7 +15,7 @@ Once a BL32 is ready, TLKD can be included in the image by adding "SPD=tlkd" to the build command. Trusted Little Kernel (TLK) -=========================== +--------------------------- TLK is a Trusted OS running as Secure EL1. It is a Free Open Source Software (FOSS) release of the NVIDIA® Trusted Little Kernel (TLK) technology, which @@ -54,20 +54,20 @@ TLK and OTE can be found in the Tegra\_BSP\_for\_Android\_TLK\_FOSS\_Reference.p manual located under the "documentation" directory\_. Build TLK -========= +--------- To build and execute TLK, follow the instructions from "Building a TLK Device" section from Tegra\_BSP\_for\_Android\_TLK\_FOSS\_Reference.pdf manual. Input parameters to TLK -======================= +----------------------- TLK expects the TZDRAM size and a structure containing the boot arguments. BL2 passes this information to the EL3 software as members of the bl32\_ep\_info struct, where bl32\_ep\_info is part of bl31\_params\_t (passed by BL2 in X0) -Example: --------- +Example +~~~~~~~ :: diff --git a/docs/components/spd/trusty-dispatcher.rst b/docs/components/spd/trusty-dispatcher.rst index be085705d..a3cb8295e 100644 --- a/docs/components/spd/trusty-dispatcher.rst +++ b/docs/components/spd/trusty-dispatcher.rst @@ -9,7 +9,7 @@ Open Source Project (AOSP) webpage for Trusty hosted at https://source.android.com/security/trusty Boot parameters -=============== +--------------- Custom boot parameters can be passed to Trusty by providing a platform specific function: @@ -26,7 +26,7 @@ can be set to a platform specific parameter block, and ``args->arg2`` should then be set to the size of that block. Supported platforms -=================== +------------------- Out of all the platforms supported by Trusted Firmware-A, Trusty is only verified and supported by NVIDIA's Tegra SoCs. diff --git a/docs/getting_started/image-terminology.rst b/docs/getting_started/image-terminology.rst index 4dc1d7346..10aebf5e4 100644 --- a/docs/getting_started/image-terminology.rst +++ b/docs/getting_started/image-terminology.rst @@ -1,9 +1,6 @@ Image Terminology ================= -.. section-numbering:: - :suffix: . - .. contents:: This page contains the current name, abbreviated name and purpose of the various diff --git a/docs/process/release-information.rst b/docs/process/release-information.rst index 0b5e7d7f1..89c19ab2a 100644 --- a/docs/process/release-information.rst +++ b/docs/process/release-information.rst @@ -1,9 +1,6 @@ Release Processes ================= -.. section-numbering:: - :suffix: . - .. contents:: --------------