mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-23 04:48:14 +00:00
Docs fixes
1) Fix links in "about" page 2) Put back the "contents" page with adjusted links Change-Id: Id09140b91df5cf0a275149801d05d8cfeeda1c6e Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
This commit is contained in:
parent
55f140591a
commit
a16fd37f11
2 changed files with 171 additions and 6 deletions
165
docs/contents.rst
Normal file
165
docs/contents.rst
Normal file
|
@ -0,0 +1,165 @@
|
||||||
|
Trusted Firmware-A Documentation Contents
|
||||||
|
=========================================
|
||||||
|
|
||||||
|
This document serves as a list of the documentation that is included with the
|
||||||
|
Trusted Firmware-A source.
|
||||||
|
|
||||||
|
Introduction
|
||||||
|
------------
|
||||||
|
|
||||||
|
`About Trusted Firmware-A`_
|
||||||
|
|
||||||
|
Getting Started
|
||||||
|
---------------
|
||||||
|
|
||||||
|
`Frequently-Asked Questions (FAQ)`_
|
||||||
|
|
||||||
|
`Image Terminology`_
|
||||||
|
|
||||||
|
`Porting Guide`_
|
||||||
|
|
||||||
|
`User Guide`_
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
------------
|
||||||
|
|
||||||
|
`Coding Style and Guidelines`_
|
||||||
|
|
||||||
|
`Contributor Acknowledgements`_
|
||||||
|
|
||||||
|
`Contributor's Guide`_
|
||||||
|
|
||||||
|
`License`_
|
||||||
|
|
||||||
|
`Maintainers`_
|
||||||
|
|
||||||
|
Processes and Policies
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
`Platform Compatibility Policy`_
|
||||||
|
|
||||||
|
`Release Processes`_
|
||||||
|
|
||||||
|
Secure Payload Dispatch
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
`OP-TEE Dispatcher`_
|
||||||
|
|
||||||
|
`Trusted Little Kernel (TLK) Dispatcher`_
|
||||||
|
|
||||||
|
`Trusty Dispatcher`_
|
||||||
|
|
||||||
|
System Design and Components
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
`Arm CPU Specific Build Macros`_
|
||||||
|
|
||||||
|
`Arm SiP Services`_
|
||||||
|
|
||||||
|
`Authentication Framework & Chain of Trust`_
|
||||||
|
|
||||||
|
`CPU Reset`_
|
||||||
|
|
||||||
|
`EL3 Runtime Service Writer’s Guide`_
|
||||||
|
|
||||||
|
`Exception Handling Framework`_
|
||||||
|
|
||||||
|
`Firmware Design Overview`_
|
||||||
|
|
||||||
|
`Firmware Update (FWU)`_
|
||||||
|
|
||||||
|
`Interrupt Management Framework`_
|
||||||
|
|
||||||
|
`Library at ROM`_
|
||||||
|
|
||||||
|
`Platform Interrupt Controller API`_
|
||||||
|
|
||||||
|
`PSCI Library Integration Guide for Armv8-A AArch32 systems`_
|
||||||
|
|
||||||
|
`PSCI Power Domain Tree design`_
|
||||||
|
|
||||||
|
`Reliability, Availability, and Serviceability (RAS) Extensions`_
|
||||||
|
|
||||||
|
`Secure Partition Manager`_
|
||||||
|
|
||||||
|
`Software Delegated Exception Interface`_
|
||||||
|
|
||||||
|
`Translation (XLAT) Tables Library`_
|
||||||
|
|
||||||
|
`Trusted Board Boot Design Guide`_
|
||||||
|
|
||||||
|
Performance and Testing
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
`PSCI Performance Measurements on Arm Juno Development Platform`_
|
||||||
|
|
||||||
|
Security and Advisories
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
`Security Processes`_
|
||||||
|
|
||||||
|
`TFV-1`_
|
||||||
|
|
||||||
|
`TFV-2`_
|
||||||
|
|
||||||
|
`TFV-3`_
|
||||||
|
|
||||||
|
`TFV-4`_
|
||||||
|
|
||||||
|
`TFV-5`_
|
||||||
|
|
||||||
|
`TFV-6`_
|
||||||
|
|
||||||
|
`TFV-7`_
|
||||||
|
|
||||||
|
`TFV-8`_
|
||||||
|
|
||||||
|
Other Documents
|
||||||
|
---------------
|
||||||
|
|
||||||
|
`Change Log`_
|
||||||
|
|
||||||
|
.. _About Trusted Firmware-A: ../readme.rst
|
||||||
|
.. _Frequently-Asked Questions (FAQ): ./process/faq.rst
|
||||||
|
.. _Image Terminology: ./getting_started/image-terminology.rst
|
||||||
|
.. _Porting Guide: ./getting_started/porting-guide.rst
|
||||||
|
.. _User Guide: ./getting_started/user-guide.rst
|
||||||
|
.. _Coding Style and Guidelines: ./process/coding-guidelines.rst
|
||||||
|
.. _Contributor Acknowledgements: ./acknowledgements.rst
|
||||||
|
.. _`Contributor's Guide`: ./process/contributing.rst
|
||||||
|
.. _License: ../license.rst
|
||||||
|
.. _Maintainers: ./maintainers.rst
|
||||||
|
.. _Platform Compatibility Policy: ./process/platform-compatibility-policy.rst
|
||||||
|
.. _Release Processes: ./process/release-information.rst
|
||||||
|
.. _Arm SiP Services: ./components/arm-sip-service.rst
|
||||||
|
.. _Exception Handling Framework: ./components/exception-handling.rst
|
||||||
|
.. _Firmware Update (FWU): ./components/firmware-update.rst
|
||||||
|
.. _Interrupt Management Framework: ./design/interrupt-framework-design.rst
|
||||||
|
.. _Library at ROM: ./components/romlib-design.rst
|
||||||
|
.. _Platform Interrupt Controller API: ./components/platform-interrupt-controller-API.rst
|
||||||
|
.. _`Reliability, Availability, and Serviceability (RAS) Extensions`: ./components/ras.rst
|
||||||
|
.. _Secure Partition Manager: ./components/secure-partition-manager-design.rst
|
||||||
|
.. _Software Delegated Exception Interface: ./components/sdei.rst
|
||||||
|
.. _Translation (XLAT) Tables Library: ./components/xlat-tables-lib-v2-design.rst
|
||||||
|
.. _OP-TEE Dispatcher: ./components/spd/optee-dispatcher.rst
|
||||||
|
.. _Trusted Little Kernel (TLK) Dispatcher: ./components/spd/tlk-dispatcher.rst
|
||||||
|
.. _Trusty Dispatcher: ./components/spd/trusty-dispatcher.rst
|
||||||
|
.. _Arm CPU Specific Build Macros: ./design/cpu-specific-build-macros.rst
|
||||||
|
.. _`Authentication Framework & Chain of Trust`: ./design/auth-framework.rst
|
||||||
|
.. _CPU Reset: ./design/reset-design.rst
|
||||||
|
.. _`EL3 Runtime Service Writer’s Guide`: ./getting_started/rt-svc-writers-guide.rst
|
||||||
|
.. _Firmware Design Overview: ./design/firmware-design.rst
|
||||||
|
.. _PSCI Library Integration Guide for Armv8-A AArch32 systems: ./getting_started/psci-lib-integration-guide.rst
|
||||||
|
.. _PSCI Power Domain Tree design: ./design/psci-pd-tree.rst
|
||||||
|
.. _Trusted Board Boot Design Guide: ./design/trusted-board-boot.rst
|
||||||
|
.. _PSCI Performance Measurements on Arm Juno Development Platform: ./perf/psci-performance-juno.rst
|
||||||
|
.. _Security Processes: ./process/security.rst
|
||||||
|
.. _Change Log: ./change-log.rst
|
||||||
|
.. _TFV-1: ./security_advisories/security-advisory-tfv-1.rst
|
||||||
|
.. _TFV-2: ./security_advisories/security-advisory-tfv-2.rst
|
||||||
|
.. _TFV-3: ./security_advisories/security-advisory-tfv-3.rst
|
||||||
|
.. _TFV-4: ./security_advisories/security-advisory-tfv-4.rst
|
||||||
|
.. _TFV-5: ./security_advisories/security-advisory-tfv-5.rst
|
||||||
|
.. _TFV-6: ./security_advisories/security-advisory-tfv-6.rst
|
||||||
|
.. _TFV-7: ./security_advisories/security-advisory-tfv-7.rst
|
||||||
|
.. _TFV-8: ./security_advisories/security-advisory-tfv-8.rst
|
12
readme.rst
12
readme.rst
|
@ -335,14 +335,14 @@ Security advisories
|
||||||
.. _Trusty Secure OS: https://source.android.com/security/trusty
|
.. _Trusty Secure OS: https://source.android.com/security/trusty
|
||||||
.. _trustedfirmware.org: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git
|
.. _trustedfirmware.org: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git
|
||||||
.. _issue tracker: https://developer.trustedfirmware.org/project/board/1/
|
.. _issue tracker: https://developer.trustedfirmware.org/project/board/1/
|
||||||
.. _Security Center: ./docs/security-center.rst
|
.. _Security Center: ./docs/process/security.rst
|
||||||
.. _license: ./license.rst
|
.. _license: ./license.rst
|
||||||
.. _Contributing Guidelines: ./contributing.rst
|
.. _Contributing Guidelines: ./docs/process/contributing.rst
|
||||||
.. _Acknowledgments: ./acknowledgements.rst
|
.. _Acknowledgments: ./docs/acknowledgements.rst
|
||||||
.. _Firmware Design: ./docs/firmware-design.rst
|
.. _Firmware Design: ./docs/design/firmware-design.rst
|
||||||
.. _Change Log: ./docs/change-log.rst
|
.. _Change Log: ./docs/change-log.rst
|
||||||
.. _User Guide: ./docs/user-guide.rst
|
.. _User Guide: ./docs/getting-started/user-guide.rst
|
||||||
.. _Porting Guide: ./docs/porting-guide.rst
|
.. _Porting Guide: ./docs/getting-started/porting-guide.rst
|
||||||
.. _FreeBSD: http://www.freebsd.org
|
.. _FreeBSD: http://www.freebsd.org
|
||||||
.. _SCC: http://www.simple-cc.org/
|
.. _SCC: http://www.simple-cc.org/
|
||||||
.. _Security Advisory TFV-1: ./docs/security_advisories/security-advisory-tfv-1.rst
|
.. _Security Advisory TFV-1: ./docs/security_advisories/security-advisory-tfv-1.rst
|
||||||
|
|
Loading…
Add table
Reference in a new issue