From 8aa050554b996406231a66a048b56fa03ba220c8 Mon Sep 17 00:00:00 2001 From: Paul Beesley Date: Thu, 7 Mar 2019 15:47:15 +0000 Subject: [PATCH] doc: Reword document titles This patch attempts to standardise the document titles as well as adding titles to documents that were missing one. The aim is to remove needless references to "TF-A" or "Trusted Firmware" in the title of every document and to make sure that the title matches with the document content. Change-Id: I9b93ccf43b5d57e8dc793a5311b8ed7c4dd245cc Signed-off-by: Paul Beesley --- docs/acknowledgements.rst | 6 +++--- docs/change-log.rst | 4 ++-- docs/components/arm-sip-service.rst | 4 ++-- docs/components/exception-handling.rst | 7 ++----- docs/components/firmware-update.rst | 7 ++----- docs/components/platform-interrupt-controller-API.rst | 6 ++---- docs/components/ras.rst | 6 ++---- docs/components/secure-partition-manager-design.rst | 7 ++----- docs/components/xlat-tables-lib-v2-design.rst | 5 +---- docs/design/auth-framework.rst | 7 ++----- docs/design/firmware-design.rst | 7 ++----- docs/design/interrupt-framework-design.rst | 7 ++----- docs/design/psci-pd-tree.rst | 7 ++----- docs/design/reset-design.rst | 4 ++-- docs/design/trusted-board-boot.rst | 4 ++-- docs/getting_started/porting-guide.rst | 6 ++---- docs/getting_started/rt-svc-writers-guide.rst | 2 +- docs/getting_started/user-guide.rst | 7 ++----- docs/index.rst | 2 +- docs/maintainers.rst | 4 ++-- docs/process/coding-guidelines.rst | 6 ++---- docs/process/contributing.rst | 4 ++-- docs/process/index.rst | 2 +- docs/process/platform-compatibility-policy.rst | 4 ++-- docs/process/release-information.rst | 4 ++-- docs/process/{security-center.rst => security.rst} | 4 ++-- 26 files changed, 49 insertions(+), 84 deletions(-) rename docs/process/{security-center.rst => security.rst} (99%) diff --git a/docs/acknowledgements.rst b/docs/acknowledgements.rst index 095b5adbb..5f2d5bc6b 100644 --- a/docs/acknowledgements.rst +++ b/docs/acknowledgements.rst @@ -1,12 +1,12 @@ +Contributor Acknowledgements +============================ + **Note: This file is only relevant for legacy contributions, to acknowledge the specific contributors referred to in "Arm Limited and Contributors" copyright notices. As contributors are now encouraged to put their name or company name directly into the copyright notices, this file is not relevant for new contributions.** -Contributor Acknowledgements -============================ - Companies --------- diff --git a/docs/change-log.rst b/docs/change-log.rst index 6893582a3..76ec07082 100644 --- a/docs/change-log.rst +++ b/docs/change-log.rst @@ -1,5 +1,5 @@ -Trusted Firmware-A Release Notes -================================ +Change Log & Release Notes +========================== This document contains a summary of the new features, changes, fixes and known issues in each release of Trusted Firmware-A. diff --git a/docs/components/arm-sip-service.rst b/docs/components/arm-sip-service.rst index 6cdac8357..9cbf19946 100644 --- a/docs/components/arm-sip-service.rst +++ b/docs/components/arm-sip-service.rst @@ -1,5 +1,5 @@ -Arm SiP Service -=============== +Arm SiP Services +================ This document enumerates and describes the Arm SiP (Silicon Provider) services. diff --git a/docs/components/exception-handling.rst b/docs/components/exception-handling.rst index e3684f133..b370c02fd 100644 --- a/docs/components/exception-handling.rst +++ b/docs/components/exception-handling.rst @@ -1,8 +1,5 @@ -Exception Handling Framework in Trusted Firmware-A -================================================== - - - +Exception Handling Framework +============================ .. contents:: :depth: 2 diff --git a/docs/components/firmware-update.rst b/docs/components/firmware-update.rst index f3ad6af1f..8124097a9 100644 --- a/docs/components/firmware-update.rst +++ b/docs/components/firmware-update.rst @@ -1,8 +1,5 @@ -Trusted Firmware-A - Firmware Update design guide -================================================= - - - +Firmware Update (FWU) +===================== .. contents:: diff --git a/docs/components/platform-interrupt-controller-API.rst b/docs/components/platform-interrupt-controller-API.rst index 42d92be2a..5c2293f09 100644 --- a/docs/components/platform-interrupt-controller-API.rst +++ b/docs/components/platform-interrupt-controller-API.rst @@ -1,7 +1,5 @@ -Platform Interrupt Controller API documentation -=============================================== - - +Platform Interrupt Controller API +================================= .. contents:: diff --git a/docs/components/ras.rst b/docs/components/ras.rst index f329fb0b2..4c16009c4 100644 --- a/docs/components/ras.rst +++ b/docs/components/ras.rst @@ -1,7 +1,5 @@ -RAS support in Trusted Firmware-A -================================= - - +Reliability, Availability, and Serviceability (RAS) Extensions +============================================================== .. contents:: :depth: 2 diff --git a/docs/components/secure-partition-manager-design.rst b/docs/components/secure-partition-manager-design.rst index 2c32eba12..91a135b98 100644 --- a/docs/components/secure-partition-manager-design.rst +++ b/docs/components/secure-partition-manager-design.rst @@ -1,8 +1,5 @@ -******************************* -Secure Partition Manager Design -******************************* - - +Secure Partition Manager +************************ .. contents:: diff --git a/docs/components/xlat-tables-lib-v2-design.rst b/docs/components/xlat-tables-lib-v2-design.rst index d55f010a3..26e4f2b9b 100644 --- a/docs/components/xlat-tables-lib-v2-design.rst +++ b/docs/components/xlat-tables-lib-v2-design.rst @@ -1,9 +1,6 @@ -Translation Tables Library Design +Translation (XLAT) Tables Library ================================= - - - .. contents:: diff --git a/docs/design/auth-framework.rst b/docs/design/auth-framework.rst index 1bc501547..dc45127f8 100644 --- a/docs/design/auth-framework.rst +++ b/docs/design/auth-framework.rst @@ -1,8 +1,5 @@ -Abstracting a Chain of Trust -============================ - - - +Authentication Framework & Chain of Trust +========================================= .. contents:: diff --git a/docs/design/firmware-design.rst b/docs/design/firmware-design.rst index e7107ba1a..d6d7b1530 100644 --- a/docs/design/firmware-design.rst +++ b/docs/design/firmware-design.rst @@ -1,8 +1,5 @@ -Trusted Firmware-A design -========================= - - - +Firmware Design +=============== .. contents:: diff --git a/docs/design/interrupt-framework-design.rst b/docs/design/interrupt-framework-design.rst index e4ec65aa1..2a641b128 100644 --- a/docs/design/interrupt-framework-design.rst +++ b/docs/design/interrupt-framework-design.rst @@ -1,8 +1,5 @@ -Trusted Firmware-A interrupt management design guide -==================================================== - - - +Interrupt Management Framework +============================== .. contents:: diff --git a/docs/design/psci-pd-tree.rst b/docs/design/psci-pd-tree.rst index 2e2163af1..23c985b6e 100644 --- a/docs/design/psci-pd-tree.rst +++ b/docs/design/psci-pd-tree.rst @@ -1,8 +1,5 @@ -PSCI Power Domain Tree design -============================= - - - +PSCI Power Domain Tree Structure +================================ .. contents:: diff --git a/docs/design/reset-design.rst b/docs/design/reset-design.rst index 147385102..405b4920d 100644 --- a/docs/design/reset-design.rst +++ b/docs/design/reset-design.rst @@ -1,5 +1,5 @@ -Trusted Firmware-A reset design -=============================== +CPU Reset +========= diff --git a/docs/design/trusted-board-boot.rst b/docs/design/trusted-board-boot.rst index ae21bf05e..76badb623 100644 --- a/docs/design/trusted-board-boot.rst +++ b/docs/design/trusted-board-boot.rst @@ -1,5 +1,5 @@ -Trusted Board Boot Design Guide -=============================== +Trusted Board Boot +================== diff --git a/docs/getting_started/porting-guide.rst b/docs/getting_started/porting-guide.rst index cad8b5c9a..f07284333 100644 --- a/docs/getting_started/porting-guide.rst +++ b/docs/getting_started/porting-guide.rst @@ -1,7 +1,5 @@ -Trusted Firmware-A Porting Guide -================================ - - +Porting Guide +============= .. contents:: diff --git a/docs/getting_started/rt-svc-writers-guide.rst b/docs/getting_started/rt-svc-writers-guide.rst index f4d786cd2..35948b547 100644 --- a/docs/getting_started/rt-svc-writers-guide.rst +++ b/docs/getting_started/rt-svc-writers-guide.rst @@ -1,4 +1,4 @@ -Trusted Firmware-A EL3 runtime service writer's guide +EL3 Runtime Service Writer's Guide ===================================================== diff --git a/docs/getting_started/user-guide.rst b/docs/getting_started/user-guide.rst index 3cc5f3cc9..894313a7f 100644 --- a/docs/getting_started/user-guide.rst +++ b/docs/getting_started/user-guide.rst @@ -1,8 +1,5 @@ -Trusted Firmware-A User Guide -============================= - - - +User Guide +========== .. contents:: diff --git a/docs/index.rst b/docs/index.rst index 8eecb3ca6..b0348f165 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,8 +14,8 @@ Trusted Firmware-A Documentation perf/index security_advisories/index change-log - maintainers acknowledgements + maintainers license Trusted Firmware-A (TF-A) provides a reference implementation of secure world diff --git a/docs/maintainers.rst b/docs/maintainers.rst index 0fa909fb6..5449faa20 100644 --- a/docs/maintainers.rst +++ b/docs/maintainers.rst @@ -1,5 +1,5 @@ -Trusted Firmware-A maintainers -============================== +Maintainers +=========== Trusted Firmware-A (TF-A) is an Arm maintained project. All contributions are ultimately merged by the maintainers listed below. Technical ownership of some diff --git a/docs/process/coding-guidelines.rst b/docs/process/coding-guidelines.rst index 644f82885..def5bf991 100644 --- a/docs/process/coding-guidelines.rst +++ b/docs/process/coding-guidelines.rst @@ -1,7 +1,5 @@ -Trusted Firmware-A Coding Guidelines -==================================== - - +Coding Style & Guidelines +========================= .. contents:: diff --git a/docs/process/contributing.rst b/docs/process/contributing.rst index bd950e511..8f8143f87 100644 --- a/docs/process/contributing.rst +++ b/docs/process/contributing.rst @@ -1,5 +1,5 @@ -Contributing to Trusted Firmware-A -================================== +Contributor's Guide +=================== Getting Started --------------- diff --git a/docs/process/index.rst b/docs/process/index.rst index 91f1beb2a..aa5d6bba7 100644 --- a/docs/process/index.rst +++ b/docs/process/index.rst @@ -7,7 +7,7 @@ Processes & Policies :numbered: release-information - security-center + security platform-compatibility-policy coding-guidelines contributing diff --git a/docs/process/platform-compatibility-policy.rst b/docs/process/platform-compatibility-policy.rst index e977e63a8..47b0e7e96 100644 --- a/docs/process/platform-compatibility-policy.rst +++ b/docs/process/platform-compatibility-policy.rst @@ -1,5 +1,5 @@ -TF-A Platform Compatibility Policy -================================== +Platform Compatibility Policy +============================= diff --git a/docs/process/release-information.rst b/docs/process/release-information.rst index 553115036..0b5e7d7f1 100644 --- a/docs/process/release-information.rst +++ b/docs/process/release-information.rst @@ -1,5 +1,5 @@ -TF-A Release Information -======================== +Release Processes +================= .. section-numbering:: :suffix: . diff --git a/docs/process/security-center.rst b/docs/process/security.rst similarity index 99% rename from docs/process/security-center.rst rename to docs/process/security.rst index 672c56322..b4831c822 100644 --- a/docs/process/security-center.rst +++ b/docs/process/security.rst @@ -1,5 +1,5 @@ -Security Center -=============== +Security Handling +================= Security Disclosures --------------------