docs: Decouple refrences from /docs folder
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: I1955201382074eb9e6dd80aadbc456eb09aecb22
diff --git a/docs/releases/1.2.0.rst b/docs/releases/1.2.0.rst
index 832474d..4e17dad 100644
--- a/docs/releases/1.2.0.rst
+++ b/docs/releases/1.2.0.rst
@@ -12,7 +12,7 @@
- Add Profile Medium.
- Migrate support to Mbed TLS v2.24.
- New platforms added.
- See :ref:`docs/releases/1.2.0:New platforms supported` for
+ See :ref:`releases/1.2.0:New platforms supported` for
details.
- New SPM HAL APIs including isolation API and logging API.
- Update MCUboot version to 1.7.0-rc1.
@@ -25,7 +25,7 @@
Stack sealing
-------------
-Refer to :doc:`Advisory TFMV-1</docs/security/security_advisories/stack_seal_vulnerability>`
+Refer to :doc:`Advisory TFMV-1</security/security_advisories/stack_seal_vulnerability>`
for more details.
A common mitigation is included in this release.
diff --git a/docs/releases/1.3.0.rst b/docs/releases/1.3.0.rst
index 0f4984f..0662368 100644
--- a/docs/releases/1.3.0.rst
+++ b/docs/releases/1.3.0.rst
@@ -18,7 +18,7 @@
- Support Armv8.1-M Privileged Execute Never (PXN) attribute and Thread
reentrancy disabled (TRD) feature.
- New platforms added.
- See :ref:`docs/releases/1.3.0:New platforms supported` for
+ See :ref:`releases/1.3.0:New platforms supported` for
details.
- Add a TF-M security landing page [7]_.
- Enhance dual-cpu non-secure mailbox reference implementation.
@@ -29,7 +29,7 @@
Invoking secure functions from non-secure handler mode
------------------------------------------------------
-Refer to :doc:`Advisory TFMV-2</docs/security/security_advisories/svc_caller_sp_fetching_vulnerability>`
+Refer to :doc:`Advisory TFMV-2</security/security_advisories/svc_caller_sp_fetching_vulnerability>`
for more details.
The mitigation is included in this release.
@@ -148,7 +148,7 @@
| 10-2020-q4-major.
| The support for CMSE feature is broken in version 10-2020-q4-major. The
| fix will be available in future release version.
- | A note is added in :ref:`docs/getting_started/tfm_getting_started:Install a toolchain`.
+ | A note is added in :ref:`getting_started/tfm_getting_started:Install a toolchain`.
- https://gcc.gnu.org/bugzilla/show_bug.cgi?id=99157
Reference
@@ -158,15 +158,15 @@
.. [2] `PSA Firmware Update API <https://developer.arm.com/documentation/ihi0093/latest/>`_
- .. [3] :doc:`TF-M generic threat model </docs/security/threat_models/generic_threat_model>`
+ .. [3] :doc:`TF-M generic threat model </security/threat_models/generic_threat_model>`
- .. [4] :doc:`TF-M physical attack mitigation </docs/technical_references/design_docs/tfm_physical_attack_mitigation>`
+ .. [4] :doc:`TF-M physical attack mitigation </technical_references/design_docs/tfm_physical_attack_mitigation>`
- .. [5] :doc:`TF-M Profile Large design </docs/technical_references/design_docs/profiles/tfm_profile_large>`
+ .. [5] :doc:`TF-M Profile Large design </technical_references/design_docs/profiles/tfm_profile_large>`
- .. [6] :doc:`Code sharing between independently linked XIP binaries </docs/technical_references/design_docs/code_sharing>`
+ .. [6] :doc:`Code sharing between independently linked XIP binaries </technical_references/design_docs/code_sharing>`
- .. [7] :doc:`Security Handling </docs/security/security>`
+ .. [7] :doc:`Security Handling </security/security>`
--------------
diff --git a/docs/releases/1.4.0.rst b/docs/releases/1.4.0.rst
index d604aee..df4d01c 100644
--- a/docs/releases/1.4.0.rst
+++ b/docs/releases/1.4.0.rst
@@ -14,7 +14,7 @@
- PSA Crypto API interface updated to be based on `Stateless Handle`.
- MCUboot updated to version 'TF-Mv1.4-integ' to support multiple images in RAM_LOAD and DIRECT_XIP upgrade strategies.
- New platforms added.
- See :ref:`docs/releases/1.4.0:New platforms supported` for details.
+ See :ref:`releases/1.4.0:New platforms supported` for details.
New security advisories
=======================
@@ -22,7 +22,7 @@
'abort' function may not take effect in some TF-M Crypto multi-part operations
------------------------------------------------------------------------------
-Refer to :doc:`Advisory TFMV-3 </docs/security/security_advisories/crypto_multi_part_ops_abort_fail>`
+Refer to :doc:`Advisory TFMV-3 </security/security_advisories/crypto_multi_part_ops_abort_fail>`
for more details.
The mitigation is included in this release.
diff --git a/docs/releases/1.5.0.rst b/docs/releases/1.5.0.rst
index 10aa015..af2a52b 100644
--- a/docs/releases/1.5.0.rst
+++ b/docs/releases/1.5.0.rst
@@ -6,7 +6,7 @@
==================
- MCUboot updated to v1.8.0.
- - :doc:`Floating-Point(FP) support in SPE only </docs/integration_guide/tfm_fpu_support>`.
+ - :doc:`Floating-Point(FP) support in SPE only </integration_guide/tfm_fpu_support>`.
- Thread mode SPM.
- Add Non-secure Client Extension (NSCE) for non-secure client ID management
support.
@@ -24,7 +24,7 @@
- Support to select/deselect single or multiple TF-M regression test cases.
- Decouple regression test flag configuration from TF-M.
- New platforms added.
- See :ref:`docs/releases/1.5.0:New platforms supported` for details.
+ See :ref:`releases/1.5.0:New platforms supported` for details.
New security advisories
=======================
@@ -34,7 +34,7 @@
NSPE may access secure keys stored in TF-M Crypto service in Profile Small with
Crypto key ID encoding disabled.
-Refer to :doc:`Advisory TFMV-4 </docs/security/security_advisories/profile_small_key_id_encoding_vulnerability>`
+Refer to :doc:`Advisory TFMV-4 </security/security_advisories/profile_small_key_id_encoding_vulnerability>`
for more details.
The mitigation is included in this release.
diff --git a/docs/releases/index.rst b/docs/releases/index.rst
index 5bd493a..2efcf2c 100644
--- a/docs/releases/index.rst
+++ b/docs/releases/index.rst
@@ -15,17 +15,17 @@
+--------------------------------------+--------------+--------------------+----------------------------+
| Version | Date | Description | PSA-arch tag/hash |
+======================================+==============+====================+============================+
-| :doc:`v1.0 </docs/releases/1.0>` | 2020-03-27 | 1.0 release | v20.03_API1.0 |
+| :doc:`v1.0 </releases/1.0>` | 2020-03-27 | 1.0 release | v20.03_API1.0 |
+--------------------------------------+--------------+--------------------+----------------------------+
-| :doc:`v1.1 </docs/releases/1.1>` | 2020-07-15 | 1.1 release | 1f960947 |
+| :doc:`v1.1 </releases/1.1>` | 2020-07-15 | 1.1 release | 1f960947 |
+--------------------------------------+--------------+--------------------+----------------------------+
-| :doc:`v1.2.0 </docs/releases/1.2.0>` | 2020-11-25 | 1.2.0 release | 90c8e680 |
+| :doc:`v1.2.0 </releases/1.2.0>` | 2020-11-25 | 1.2.0 release | 90c8e680 |
+--------------------------------------+--------------+--------------------+----------------------------+
-| :doc:`v1.3.0 </docs/releases/1.3.0>` | 2021-04-07 | 1.3.0 release | b0635d9 |
+| :doc:`v1.3.0 </releases/1.3.0>` | 2021-04-07 | 1.3.0 release | b0635d9 |
+--------------------------------------+--------------+--------------------+----------------------------+
-| :doc:`v1.4.0 </docs/releases/1.4.0>` | 2021-08-03 | 1.4.0 release | 51ff2bd |
+| :doc:`v1.4.0 </releases/1.4.0>` | 2021-08-03 | 1.4.0 release | 51ff2bd |
+--------------------------------------+--------------+--------------------+----------------------------+
-| :doc:`v1.5.0 </docs/releases/1.5.0>` | 2021-11-30 | 1.5.0 release | v21.10_API1.3_ADAC_ALPHA-1 |
+| :doc:`v1.5.0 </releases/1.5.0>` | 2021-11-30 | 1.5.0 release | v21.10_API1.3_ADAC_ALPHA-1 |
+--------------------------------------+--------------+--------------------+----------------------------+
Future release plans
@@ -44,7 +44,7 @@
+--------------------------------------+-----------------+---------------+
Please refer to
-:ref:`docs/releases/release_process:Release Cadence and Process` for
+:ref:`releases/release_process:Release Cadence and Process` for
interpreting version numbers.
--------------
diff --git a/docs/releases/release_process.rst b/docs/releases/release_process.rst
index cb35ec2..9b3b011 100644
--- a/docs/releases/release_process.rst
+++ b/docs/releases/release_process.rst
@@ -5,7 +5,7 @@
-----------------------
The project aims to do a release once every 6 months around April and November
-time and are listed in the :ref:`docs/releases/index:Future release plans`.
+time and are listed in the :ref:`releases/index:Future release plans`.
The releases are to be performed and tagged on a dedicated release branch.
The release process is initiated by an announcement in
`TF-M mailing list <https://lists.trustedfirmware.org/mailman/listinfo/tf-m>`_
@@ -14,7 +14,7 @@
The testing will be performed on release candidates and depending on
issues found, additional candidates may be created to fix and retest the issues.
-:doc:`The Platform owners </docs/contributing/maintainers>` are expected to
+:doc:`The Platform owners </contributing/maintainers>` are expected to
verify their platforms and confirm the correct operations or provide fixes
in a timely manner to include in the release. The release notes will list
all verified platforms. The platforms in Trusted Firmware OpenCI is