Djam/arm-trusted-firmware
1
0
Fork 0
mirror of https://github.com/ARM-software/arm-trusted-firmware.git synced 2025-04-22 20:38:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Remove per-page contents lists

Browse source 
These are no longer needed as there will always be a table of contents
rendered to the left of every page.

Some of these lists can be quite long and, when opening a page, the
reader sees nothing but a huge list of contents! After this patch,
the document contents are front-and-centre and the contents are
nicely rendered in the sidebar without duplication.

Change-Id: I444754d548ec91d00f2b04e861de8dde8856aa62
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
This commit is contained in:
Paul Beesley 2019-03-07 17:03:22 +00:00
parent 1ef35512cf
commit 57354abb20
26 changed files with 4 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/change-log.rst
View file

@ -4,8 +4,6 @@ Change Log & Release Notes
This document contains a summary of the new features, changes, fixes and known This document contains a summary of the new features, changes, fixes and known
issues in each release of Trusted Firmware-A. issues in each release of Trusted Firmware-A.
.. contents::
Version 2.1 Version 2.1
----------- -----------

3
docs/components/exception-handling.rst
View file

@ -1,9 +1,6 @@
Exception Handling Framework Exception Handling Framework
============================ ============================
.. contents::
:depth: 2
.. |EHF| replace:: Exception Handling Framework .. |EHF| replace:: Exception Handling Framework
.. |TF-A| replace:: Trusted Firmware-A .. |TF-A| replace:: Trusted Firmware-A

4
docs/components/firmware-update.rst
View file

@ -1,10 +1,6 @@
Firmware Update (FWU) Firmware Update (FWU)
===================== =====================
.. contents::
--------------
Introduction Introduction
------------ ------------

2
docs/components/platform-interrupt-controller-API.rst
View file

@ -1,8 +1,6 @@
Platform Interrupt Controller API Platform Interrupt Controller API
================================= =================================
.. contents::
This document lists the optional platform interrupt controller API that This document lists the optional platform interrupt controller API that
abstracts the runtime configuration and control of interrupt controller from the abstracts the runtime configuration and control of interrupt controller from the
generic code. The mandatory APIs are described in the `porting guide`__. generic code. The mandatory APIs are described in the `porting guide`__.

3
docs/components/ras.rst
View file

@ -1,9 +1,6 @@
Reliability, Availability, and Serviceability (RAS) Extensions Reliability, Availability, and Serviceability (RAS) Extensions
============================================================== ==============================================================
.. contents::
:depth: 2
.. |EHF| replace:: Exception Handling Framework .. |EHF| replace:: Exception Handling Framework
.. |TF-A| replace:: Trusted Firmware-A .. |TF-A| replace:: Trusted Firmware-A

2
docs/components/romlib-design.rst
View file

@ -1,8 +1,6 @@
Library at ROM Library at ROM
============== ==============
.. contents::
This document provides an overview of the "library at ROM" implementation in This document provides an overview of the "library at ROM" implementation in
Trusted Firmware-A (TF-A). Trusted Firmware-A (TF-A).

3
docs/components/sdei.rst
View file

@ -1,9 +1,6 @@
SDEI: Software Delegated Exception Interface SDEI: Software Delegated Exception Interface
============================================ ============================================
.. contents::
:depth: 2
This document provides an overview of the SDEI dispatcher implementation in This document provides an overview of the SDEI dispatcher implementation in
Trusted Firmware-A (TF-A). Trusted Firmware-A (TF-A).

2
docs/components/secure-partition-manager-design.rst
View file

@ -1,8 +1,6 @@
Secure Partition Manager Secure Partition Manager
************************ ************************
.. contents::
Background Background
========== ==========

3
docs/components/xlat-tables-lib-v2-design.rst
View file

@ -1,9 +1,6 @@
Translation (XLAT) Tables Library Translation (XLAT) Tables Library
================================= =================================
.. contents::
This document describes the design of the translation tables library (version 2) This document describes the design of the translation tables library (version 2)
used by Trusted Firmware-A (TF-A). This library provides APIs to create page used by Trusted Firmware-A (TF-A). This library provides APIs to create page
tables based on a description of the memory layout, as well as setting up system tables based on a description of the memory layout, as well as setting up system

2
docs/design/auth-framework.rst
View file

@ -1,8 +1,6 @@
Authentication Framework & Chain of Trust Authentication Framework & Chain of Trust
========================================= =========================================
.. contents::
The aim of this document is to describe the authentication framework The aim of this document is to describe the authentication framework
implemented in Trusted Firmware-A (TF-A). This framework fulfills the implemented in Trusted Firmware-A (TF-A). This framework fulfills the
following requirements: following requirements:

5
docs/design/cpu-specific-build-macros.rst
View file

@ -1,11 +1,6 @@
Arm CPU Specific Build Macros Arm CPU Specific Build Macros
============================= =============================
.. contents::
This document describes the various build options present in the CPU specific This document describes the various build options present in the CPU specific
operations framework to enable errata workarounds and to enable optimizations operations framework to enable errata workarounds and to enable optimizations
for a specific CPU on a platform. for a specific CPU on a platform.

2
docs/design/firmware-design.rst
View file

@ -1,8 +1,6 @@
Firmware Design Firmware Design
=============== ===============
.. contents::
Trusted Firmware-A (TF-A) implements a subset of the Trusted Board Boot Trusted Firmware-A (TF-A) implements a subset of the Trusted Board Boot
Requirements (TBBR) Platform Design Document (PDD) [1]_ for Arm reference Requirements (TBBR) Platform Design Document (PDD) [1]_ for Arm reference
platforms. The TBB sequence starts when the platform is powered on and runs up platforms. The TBB sequence starts when the platform is powered on and runs up

2
docs/design/interrupt-framework-design.rst
View file

@ -1,8 +1,6 @@
Interrupt Management Framework Interrupt Management Framework
============================== ==============================
.. contents::
This framework is responsible for managing interrupts routed to EL3. It also This framework is responsible for managing interrupts routed to EL3. It also
allows EL3 software to configure the interrupt routing behavior. Its main allows EL3 software to configure the interrupt routing behavior. Its main
objective is to implement the following two requirements. objective is to implement the following two requirements.

4
docs/design/psci-pd-tree.rst
View file

@ -1,10 +1,6 @@
PSCI Power Domain Tree Structure PSCI Power Domain Tree Structure
================================ ================================
.. contents::
--------------
Requirements Requirements
------------ ------------

5
docs/design/reset-design.rst
View file

@ -1,11 +1,6 @@
CPU Reset CPU Reset
========= =========
.. contents::
This document describes the high-level design of the framework to handle CPU This document describes the high-level design of the framework to handle CPU
resets in Trusted Firmware-A (TF-A). It also describes how the platform resets in Trusted Firmware-A (TF-A). It also describes how the platform
integrator can tailor this code to the system configuration to some extent, integrator can tailor this code to the system configuration to some extent,

5
docs/design/trusted-board-boot.rst
View file

@ -1,11 +1,6 @@
Trusted Board Boot Trusted Board Boot
================== ==================
.. contents::
The Trusted Board Boot (TBB) feature prevents malicious firmware from running on The Trusted Board Boot (TBB) feature prevents malicious firmware from running on
the platform by authenticating all firmware images up to and including the the platform by authenticating all firmware images up to and including the
normal world bootloader. It does this by establishing a Chain of Trust using normal world bootloader. It does this by establishing a Chain of Trust using

2
docs/getting_started/image-terminology.rst
View file

@ -1,8 +1,6 @@
Image Terminology Image Terminology
================= =================
.. contents::
This page contains the current name, abbreviated name and purpose of the various This page contains the current name, abbreviated name and purpose of the various
images referred to in the Trusted Firmware project. images referred to in the Trusted Firmware project.

2
docs/getting_started/porting-guide.rst
View file

@ -1,8 +1,6 @@
Porting Guide Porting Guide
============= =============
.. contents::
Introduction Introduction
------------ ------------

4
docs/getting_started/psci-lib-integration-guide.rst
View file

@ -1,10 +1,6 @@
PSCI Library Integration guide for Armv8-A AArch32 systems PSCI Library Integration guide for Armv8-A AArch32 systems
========================================================== ==========================================================
.. contents::
This document describes the PSCI library interface with a focus on how to This document describes the PSCI library interface with a focus on how to
integrate with a suitable Trusted OS for an Armv8-A AArch32 system. The PSCI integrate with a suitable Trusted OS for an Armv8-A AArch32 system. The PSCI
Library implements the PSCI Standard as described in `PSCI spec`_ and is meant Library implements the PSCI Standard as described in `PSCI spec`_ and is meant

4
docs/getting_started/rt-svc-writers-guide.rst
View file

@ -1,10 +1,6 @@
EL3 Runtime Service Writer's Guide EL3 Runtime Service Writer's Guide
===================================================== =====================================================
.. contents::
Introduction Introduction
------------ ------------

2
docs/getting_started/user-guide.rst
View file

@ -1,8 +1,6 @@
User Guide User Guide
========== ==========
.. contents::
This document describes how to build Trusted Firmware-A (TF-A) and run it with a This document describes how to build Trusted Firmware-A (TF-A) and run it with a
tested set of other software components using defined configurations on the Juno tested set of other software components using defined configurations on the Juno
Arm development platform and Arm Fixed Virtual Platform (FVP) models. It is Arm development platform and Arm Fixed Virtual Platform (FVP) models. It is

5
docs/index.rst
View file

@ -3,7 +3,7 @@ Trusted Firmware-A Documentation
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: Contents :hidden:
Home<self> Home<self>
getting_started/index getting_started/index
@ -18,6 +18,9 @@ Trusted Firmware-A Documentation
maintainers maintainers
license license
.. contents:: On This Page
:depth: 3
Trusted Firmware-A (TF-A) provides a reference implementation of secure world Trusted Firmware-A (TF-A) provides a reference implementation of secure world
software for `Armv7-A and Armv8-A`_, including a `Secure Monitor`_ executing software for `Armv7-A and Armv8-A`_, including a `Secure Monitor`_ executing
at Exception Level 3 (EL3). It implements various Arm interface standards, at Exception Level 3 (EL3). It implements various Arm interface standards,

2
docs/plat/rpi3.rst
View file

@ -1,8 +1,6 @@
Raspberry Pi 3 Raspberry Pi 3
============== ==============
.. contents::
The `Raspberry Pi 3`_ is an inexpensive single-board computer that contains four The `Raspberry Pi 3`_ is an inexpensive single-board computer that contains four
Arm Cortex-A53 cores. Arm Cortex-A53 cores.

2
docs/process/coding-guidelines.rst
View file

@ -1,8 +1,6 @@
Coding Style & Guidelines Coding Style & Guidelines
========================= =========================
.. contents::
The following sections contain TF coding guidelines. They are continually The following sections contain TF coding guidelines. They are continually
evolving and should not be considered "set in stone". Feel free to question them evolving and should not be considered "set in stone". Feel free to question them
and provide feedback. and provide feedback.

7
docs/process/platform-compatibility-policy.rst
View file

@ -1,13 +1,6 @@
Platform Compatibility Policy Platform Compatibility Policy
============================= =============================
.. contents::
--------------
Introduction Introduction
------------ ------------

4
docs/process/release-information.rst
View file

@ -1,10 +1,6 @@
Release Processes Release Processes
================= =================
.. contents::
--------------
Project Release Cadence Project Release Cadence
----------------------- -----------------------