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 <paul.beesley@arm.com>
2025-04-16 01:24:27 +00:00 · 2019-03-07 15:47:15 +00:00 · 2019-03-07 15:47:15 +00:00 · 8aa050554b
commit 8aa050554b
parent b27c7d6f05
26 changed files with 49 additions and 84 deletions
--- 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
 ---------

--- 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.
--- 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.

--- 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
--- 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::

--- 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::

--- 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
--- 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::

--- 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::


--- 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::

--- a/docs/design/firmware-design.rst
+++ b/docs/design/firmware-design.rst
@ -1,8 +1,5 @@
-Trusted Firmware-A design
-=========================
-
-
-
+Firmware Design
+===============

 .. contents::

--- 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::

--- 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::

--- a/docs/design/reset-design.rst
+++ b/docs/design/reset-design.rst
@ -1,5 +1,5 @@
-Trusted Firmware-A reset design
-===============================
+CPU Reset
+=========



--- 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
+==================



--- 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::

--- 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
 =====================================================


--- 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::

--- 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
--- 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
--- 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::

--- a/docs/process/contributing.rst
+++ b/docs/process/contributing.rst
@ -1,5 +1,5 @@
-Contributing to Trusted Firmware-A
-==================================
+Contributor's Guide
+===================

 Getting Started
 ---------------
--- 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
--- 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
+=============================



--- 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: .
--- a/docs/process/security-center.rst
+++ b/docs/process/security-center.rst
@ -1,5 +1,5 @@
-Security Center
-===============
+Security Handling
+=================

 Security Disclosures
 --------------------