doc: Add contents.rst to link to pages

This is the temporary contents page that links
to all other documents (except platform ports).

This page is needed during the
trustedfirmware.org migration, before we have a
Sphinx rendering pipeline set up, because cgit
doesn't offer a good way to view rendered docs
while browsing the tree. We need to have a links
page that can be opened from the cgit 'about'
view.

Change-Id: I3ad87a9fa8a14dc8e371aac7ee473575fed316bf
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
This commit is contained in:
Paul Beesley 2019-03-25 16:42:19 +00:00
parent 2c269b4736
commit 9dc5f21ec2
1 changed files with 165 additions and 0 deletions

165
docs/contents.rst Normal file
View 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 Writers 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): ./frequently-asked-questions.rst
.. _Image Terminology: ./image-terminology.rst
.. _Porting Guide: ./porting-guide.rst
.. _User Guide: ./user-guide.rst
.. _Coding Style and Guidelines: ./coding-guidelines.rst
.. _Contributor Acknowledgements: ../acknowledgements.rst
.. _`Contributor's Guide`: ../contributing.rst
.. _License: ../license.rst
.. _Maintainers: ../maintainers.rst
.. _Platform Compatibility Policy: ./platform-compatibility-policy.rst
.. _Release Processes: ./release-information.rst
.. _Arm SiP Services: ./arm-sip-service.rst
.. _Exception Handling Framework: ./exception-handling.rst
.. _Firmware Update (FWU): ./firmware-update.rst
.. _Interrupt Management Framework: ./interrupt-framework-design.rst
.. _Library at ROM: ./romlib-design.rst
.. _Platform Interrupt Controller API: ./platform-interrupt-controller-API.rst
.. _`Reliability, Availability, and Serviceability (RAS) Extensions`: ./ras.rst
.. _Secure Partition Manager: ./secure-partition-manager-design.rst
.. _Software Delegated Exception Interface: ./sdei.rst
.. _Translation (XLAT) Tables Library: ./xlat-tables-lib-v2-design.rst
.. _OP-TEE Dispatcher: ./spd/optee-dispatcher.rst
.. _Trusted Little Kernel (TLK) Dispatcher: ./spd/tlk-dispatcher.rst
.. _Trusty Dispatcher: ./spd/trusty-dispatcher.rst
.. _Arm CPU Specific Build Macros: ./cpu-specific-build-macros.rst
.. _`Authentication Framework & Chain of Trust`: ./auth-framework.rst
.. _CPU Reset: ./reset-design.rst
.. _`EL3 Runtime Service Writers Guide`: ./rt-svc-writers-guide.rst
.. _Firmware Design Overview: ./firmware-design.rst
.. _PSCI Library Integration Guide for Armv8-A AArch32 systems: ./psci-lib-integration-guide.rst
.. _PSCI Power Domain Tree design: ./psci-pd-tree.rst
.. _Trusted Board Boot Design Guide: ./trusted-board-boot.rst
.. _PSCI Performance Measurements on Arm Juno Development Platform: ./psci-performance-juno.rst
.. _Security Processes: ./security-center.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