From 0c6be93fc2595a9d3491146e15bc7c1d929ddee4 Mon Sep 17 00:00:00 2001 From: Paul Beesley Date: Tue, 5 Mar 2019 17:19:37 +0000 Subject: [PATCH] doc: Add and correct headings for imported files Some files imported from the wiki are missing RST section headers and other files are using inconsistent characters for the same header level. Change-Id: I318c843f9bc8fb40074ef90827b9acac06463662 Signed-off-by: Paul Beesley --- docs/frequently-asked-questions.rst | 3 +++ docs/image-terminology.rst | 21 +++++++++++++++------ docs/psci-performance-juno.rst | 3 +++ docs/security-center.rst | 3 +++ 4 files changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/frequently-asked-questions.rst b/docs/frequently-asked-questions.rst index c0cbc0dcf..7a4ff0ede 100644 --- a/docs/frequently-asked-questions.rst +++ b/docs/frequently-asked-questions.rst @@ -1,3 +1,6 @@ +Frequently-Asked Questions (FAQ) +================================ + How do I update a Pull Request? ------------------------------- diff --git a/docs/image-terminology.rst b/docs/image-terminology.rst index 1c6429778..4dc1d7346 100644 --- a/docs/image-terminology.rst +++ b/docs/image-terminology.rst @@ -1,10 +1,16 @@ -Trusted Firmware images ------------------------ +Image Terminology +================= + +.. section-numbering:: + :suffix: . + +.. contents:: This page contains the current name, abbreviated name and purpose of the various images referred to in the Trusted Firmware project. -Some general notes: +General Notes +------------- - Some of the names and abbreviated names have changed to accomodate new requirements. The changed names are as backward compatible as possible to @@ -36,6 +42,9 @@ Some general notes: - The image names are not case sensitive. For example, ``bl1`` is interchangeable with ``BL1``, although mixed case should be avoided. +Trusted Firmware Images +----------------------- + AP Boot ROM: ``AP_BL1`` ~~~~~~~~~~~~~~~~~~~~~~~ @@ -114,8 +123,8 @@ This image was previously abbreviated as BL3-0 but from the SCP's point of view, this has always been the 2nd stage firmware. The previous name is too AP-centric. -Firmware update images ----------------------- +Firmware Update (FWU) Images +---------------------------- The terminology for these images has not been widely adopted yet but they have to be considered in a production Trusted Board Boot solution. @@ -154,7 +163,7 @@ This is the 2nd stage AP normal world firmware updater. Its primary purpose is to load a new set of firmware images from an external interface and write them into non-volatile storage. -Other processor firmware images +Other Processor Firmware Images ------------------------------- Some systems may have additional processors to the AP and SCP. For example, a diff --git a/docs/psci-performance-juno.rst b/docs/psci-performance-juno.rst index 621c8bf81..caed8bf9a 100644 --- a/docs/psci-performance-juno.rst +++ b/docs/psci-performance-juno.rst @@ -1,3 +1,6 @@ +PSCI Performance Measurements on Arm Juno Development Platform +============================================================== + This document summarises the findings of performance measurements of key operations in the ARM Trusted Firmware (TF) Power State Coordination Interface (PSCI) implementation, using the in-built Performance Measurement Framework diff --git a/docs/security-center.rst b/docs/security-center.rst index 1c82f29e4..672c56322 100644 --- a/docs/security-center.rst +++ b/docs/security-center.rst @@ -1,3 +1,6 @@ +Security Center +=============== + Security Disclosures --------------------