diff options
author | Paul Beesley <paul.beesley@arm.com> | 2019-04-12 14:19:42 +0100 |
---|---|---|
committer | Paul Beesley <paul.beesley@arm.com> | 2019-10-08 15:58:03 +0000 |
commit | 347609510e30f5cc3f33beaad3cf085e8296b883 (patch) | |
tree | 62ad23464d73b66c256d75cc5e276445b35088ac /docs/change-log.rst | |
parent | 4fdad60c34549adb0a420e826394286d1d983df3 (diff) | |
download | platform_external_arm-trusted-firmware-347609510e30f5cc3f33beaad3cf085e8296b883.tar.gz platform_external_arm-trusted-firmware-347609510e30f5cc3f33beaad3cf085e8296b883.tar.bz2 platform_external_arm-trusted-firmware-347609510e30f5cc3f33beaad3cf085e8296b883.zip |
doc: Convert internal links to RST format
Currently links between documents are using the format:
<path/to/><filename>.rst
This was required for services like GitHub because they render each
document in isolation - linking to another document is like linking
to any other file, just provide the full path.
However, with the new approach, the .rst files are only the raw
source for the documents. Once the documents have been rendered
the output is now in another format (HTML in our case) and so,
when linking to another document, the link must point to the
rendered version and not the .rst file.
The RST spec provides a few methods for linking between content.
The parent of this patch enabled the automatic creation of anchors
for document titles - we will use these anchors as the targets for
our links. Additional anchors can be added by hand if needed, on
section and sub-section titles, for example.
An example of this new format, for a document with the title
"Firmware Design" is :ref:`Firmware Design`.
One big advantage of this is that anchors are not dependent on
paths. We can then move documents around, even between directories,
without breaking any links between documents. Links will need to be
updated only if the title of a document changes.
Change-Id: I9e2340a61dd424cbd8fd1ecc2dc166f460d81703
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Diffstat (limited to 'docs/change-log.rst')
-rw-r--r-- | docs/change-log.rst | 37 |
1 files changed, 14 insertions, 23 deletions
diff --git a/docs/change-log.rst b/docs/change-log.rst index 70aafc063..0a89aa6f8 100644 --- a/docs/change-log.rst +++ b/docs/change-log.rst @@ -22,8 +22,8 @@ New Features and ``CTX_INCLUDE_PAUTH_REGS`` build flags, pointer authentication can be enabled in EL3 and S-EL1/0. - See the `Firmware Design`_ document for additional details on the use of - pointer authentication. + See the :ref:`Firmware Design` document for additional details on the use + of pointer authentication. - Enable Data Independent Timing (DIT) in EL3, where supported @@ -1359,7 +1359,7 @@ New features The PSCI library has been refactored to allow integration with **EL3 Runtime Software**. This is software that is executing at the highest secure privilege which is EL3 in AArch64 or Secure SVC/Monitor mode in AArch32. See - `PSCI Integration Guide`_. + :ref:`PSCI Library Integration guide for Armv8-A AArch32 systems`. Included is a minimal AArch32 Secure Payload, **SP-MIN**, that illustrates the usage and integration of the PSCI library with EL3 Runtime Software @@ -1402,11 +1402,11 @@ New features Commits now must have a 'Signed-off-by:' field to certify that the contribution has been made under the terms of the - `Developer Certificate of Origin`_. + :download:`Developer Certificate of Origin <../dco.txt>`. A signed CLA is no longer required. - The `Contribution Guide`_ has been updated to reflect this change. + The :ref:`Contributor's Guide` has been updated to reflect this change. - Introduced Performance Measurement Framework (PMF) which provides support for capturing, storing, dumping and retrieving time-stamps to measure the @@ -1620,13 +1620,13 @@ New features - Added the following new design documents: - - `Authentication framework`_ - - `Firmware Update`_ - - `TF-A Reset Design`_ - - `Power Domain Topology Design`_ + - :ref:`Authentication Framework & Chain of Trust` + - :ref:`Firmware Update (FWU)` + - :ref:`CPU Reset` + - :ref:`PSCI Power Domain Tree Structure` - Applied the new image terminology to the code base and documentation, as - described in the `image terminology document`_. + described in the :ref:`Image Terminology` document. - The build system has been reworked to improve readability and facilitate adding future extensions. @@ -1694,7 +1694,8 @@ Issues resolved since last release ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - The Trusted Board Boot implementation has been redesigned to provide greater - modularity and scalability. See the `Authentication Framework`_ document. + modularity and scalability. See the + :ref:`Authentication Framework & Chain of Trust` document. All missing mandatory features are now implemented. - The FVP and Juno ports may now use the hash of the ROTPK stored in the @@ -1826,7 +1827,7 @@ New features create mappings only for areas in the memory map that it needs. - A Secure Payload Dispatcher (OPTEED) for the OP-TEE Trusted OS has been - added. Details of using it with TF-A can be found in `OP-TEE Dispatcher`_ + added. Details of using it with TF-A can be found in :ref:`OP-TEE Dispatcher` Issues resolved since last release ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -2423,16 +2424,6 @@ releases of TF-A. *Copyright (c) 2013-2019, Arm Limited and Contributors. All rights reserved.* .. _SDEI Specification: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf -.. _PSCI Integration Guide: ./getting_started/psci-lib-integration-guide.rst -.. _Developer Certificate of Origin: ../dco.txt -.. _Contribution Guide: ./process/contributing.rst -.. _Authentication framework: ./design/auth-framework.rst -.. _Firmware Update: ./design/firmware-update.rst -.. _Firmware Design: ./design/firmware-design.rst -.. _TF-A Reset Design: ./design/reset-design.rst -.. _Power Domain Topology Design: ./design/psci-pd-tree.rst -.. _image terminology document: ./getting_started/image-terminology.rst -.. _Authentication Framework: ./design/auth-framework.rst -.. _OP-TEE Dispatcher: ./spd/optee-dispatcher.rst .. _tf-issue#501: https://github.com/ARM-software/tf-issues/issues/501 .. _PR#1002: https://github.com/ARM-software/arm-trusted-firmware/pull/1002#issuecomment-312650193 +.. _mbed TLS releases: https://tls.mbed.org/tech-updates/releases |