docs: Decouple refrences from /docs folder
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: I1955201382074eb9e6dd80aadbc456eb09aecb22
diff --git a/docs/technical_references/design_docs/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst b/docs/technical_references/design_docs/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst
index 5f1bd98..f8688c1 100644
--- a/docs/technical_references/design_docs/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst
+++ b/docs/technical_references/design_docs/dual-cpu/communication_prototype_between_nspe_and_spe_in_dual_core_systems.rst
@@ -699,7 +699,7 @@
*********
.. [1] :doc:`Mailbox Design in TF-M on Dual-core System <./mailbox_design_on_dual_core_system>`
-.. [2] :doc:`Secure Interrupt Integration Guide </docs/integration_guide/tfm_secure_irq_integration_guide>`
+.. [2] :doc:`Secure Interrupt Integration Guide </integration_guide/tfm_secure_irq_integration_guide>`
----------------
diff --git a/docs/technical_references/design_docs/ff_isolation.rst b/docs/technical_references/design_docs/ff_isolation.rst
index 41dd4fc..daa8b48 100644
--- a/docs/technical_references/design_docs/ff_isolation.rst
+++ b/docs/technical_references/design_docs/ff_isolation.rst
@@ -10,7 +10,7 @@
complies the rules by operating the hardware and software resources.
.. note::
- Reference the document :doc:`Glossary </docs/glossary>` for terms
+ Reference the document :doc:`Glossary </glossary>` for terms
and abbreviations.
************
diff --git a/docs/technical_references/design_docs/hardware_abstraction_layer.rst b/docs/technical_references/design_docs/hardware_abstraction_layer.rst
index 6a0f6ed..05f8aae 100644
--- a/docs/technical_references/design_docs/hardware_abstraction_layer.rst
+++ b/docs/technical_references/design_docs/hardware_abstraction_layer.rst
@@ -61,7 +61,7 @@
- There is a non-secure :term:`HAL` that focuses on the mailbox operation API
for Dual-core topology. For more information about it, please refer to
:doc:`Mailbox Design in TF-M on Dual-core System
- </docs/technical_references/design_docs/dual-cpu/mailbox_design_on_dual_core_system>`.
+ </technical_references/design_docs/dual-cpu/mailbox_design_on_dual_core_system>`.
- The minimal set of :term:`TF-M` :term:`HAL` is sufficient for Secure
Partitions by using customized peripheral interfaces. To provide easier
portability for the Secure Partitions, a Secure Partition :term:`HAL` is
diff --git a/docs/technical_references/design_docs/profiles/tfm_profile_large.rst b/docs/technical_references/design_docs/profiles/tfm_profile_large.rst
index 3f254bb..2f6d00a 100644
--- a/docs/technical_references/design_docs/profiles/tfm_profile_large.rst
+++ b/docs/technical_references/design_docs/profiles/tfm_profile_large.rst
@@ -438,9 +438,9 @@
Reference
*********
-.. [1] :doc:`Trusted Firmware-M Profile Small Design </docs/technical_references/design_docs/profiles/tfm_profile_small>`
+.. [1] :doc:`Trusted Firmware-M Profile Small Design </technical_references/design_docs/profiles/tfm_profile_small>`
-.. [2] :doc:`Trusted Firmware-M Profile Medium Design </docs/technical_references/design_docs/profiles/tfm_profile_medium>`
+.. [2] :doc:`Trusted Firmware-M Profile Medium Design </technical_references/design_docs/profiles/tfm_profile_medium>`
.. [3] `PSA Certified Level 3 Lightweight Protection Profile <https://www.psacertified.org/app/uploads/2020/12/JSADEN009-PSA_Certified_Level_3_LW_PP-1.0-BET02.pdf>`_
@@ -448,13 +448,13 @@
.. [5] `The Transport Layer Security (TLS) Protocol Version 1.2 <https://tools.ietf.org/html/rfc5246>`_
-.. [6] :doc:`Physical attack mitigation in Trusted Firmware-M </docs/technical_references/design_docs/tfm_physical_attack_mitigation>`
+.. [6] :doc:`Physical attack mitigation in Trusted Firmware-M </technical_references/design_docs/tfm_physical_attack_mitigation>`
-.. [7] :doc:`Crypto design </docs/technical_references/design_docs/tfm_crypto_design>`
+.. [7] :doc:`Crypto design </technical_references/design_docs/tfm_crypto_design>`
-.. [8] :doc:`ITS integration guide </docs/integration_guide/services/tfm_its_integration_guide>`
+.. [8] :doc:`ITS integration guide </integration_guide/services/tfm_its_integration_guide>`
-.. [9] :doc:`TF-M build instruction </docs/technical_references/instructions/tfm_build_instruction>`
+.. [9] :doc:`TF-M build instruction </technical_references/instructions/tfm_build_instruction>`
--------------
diff --git a/docs/technical_references/design_docs/profiles/tfm_profile_medium.rst b/docs/technical_references/design_docs/profiles/tfm_profile_medium.rst
index 2f961da..84b7c09 100644
--- a/docs/technical_references/design_docs/profiles/tfm_profile_medium.rst
+++ b/docs/technical_references/design_docs/profiles/tfm_profile_medium.rst
@@ -472,7 +472,7 @@
.. [RFC7925] `Transport Layer Security (TLS) / Datagram Transport Layer Security (DTLS) Profiles for the Internet of Things <https://tools.ietf.org/html/rfc7925>`_
-.. [PROFILE-S] :doc:`Trusted Firmware-M Profile Small Design </docs/technical_references/design_docs/profiles/tfm_profile_small>`
+.. [PROFILE-S] :doc:`Trusted Firmware-M Profile Small Design </technical_references/design_docs/profiles/tfm_profile_small>`
.. [RFC7252] `The Constrained Application Protocol (CoAP) <https://tools.ietf.org/html/rfc7252>`_
@@ -480,11 +480,11 @@
.. [RFC7251] `AES-CCM Elliptic Curve Cryptography (ECC) Cipher Suites for TLS <https://tools.ietf.org/html/rfc7251>`_
-.. [CRYPTO-DESIGN] :doc:`Crypto design </docs/technical_references/design_docs/tfm_crypto_design>`
+.. [CRYPTO-DESIGN] :doc:`Crypto design </technical_references/design_docs/tfm_crypto_design>`
-.. [ITS-INTEGRATE] :doc:`ITS integration guide </docs/integration_guide/services/tfm_its_integration_guide>`
+.. [ITS-INTEGRATE] :doc:`ITS integration guide </integration_guide/services/tfm_its_integration_guide>`
-.. [TFM-BUILD] :doc:`TF-M build instruction </docs/technical_references/instructions/tfm_build_instruction>`
+.. [TFM-BUILD] :doc:`TF-M build instruction </technical_references/instructions/tfm_build_instruction>`
--------------
diff --git a/docs/technical_references/design_docs/profiles/tfm_profile_small.rst b/docs/technical_references/design_docs/profiles/tfm_profile_small.rst
index b14befc..b008feb 100644
--- a/docs/technical_references/design_docs/profiles/tfm_profile_small.rst
+++ b/docs/technical_references/design_docs/profiles/tfm_profile_small.rst
@@ -665,15 +665,15 @@
.. [8] `Transitioning the Use of Cryptographic Algorithms and Key Lengths <https://www.nist.gov/publications/transitioning-use-cryptographic-algorithms-and-key-lengths>`_
-.. [9] :doc:`ITS integration guide </docs/integration_guide/services/tfm_its_integration_guide>`
+.. [9] :doc:`ITS integration guide </integration_guide/services/tfm_its_integration_guide>`
.. [10] `PSA Attestation API 1.0 (ARM IHI 0085) <https://developer.arm.com/-/media/Files/pdf/PlatformSecurityArchitecture/Implement/IHI0085-PSA_Attestation_API-1.0.2.pdf?revision=eef78753-c77e-4b24-bcf0-65596213b4c1&la=en&hash=E5E0353D612077AFDCE3F2F3708A50C77A74B2A3>`_
-.. [11] :doc:`Secure boot </docs/technical_references/design_docs/tfm_secure_boot>`
+.. [11] :doc:`Secure boot </technical_references/design_docs/tfm_secure_boot>`
-.. [12] :doc:`Crypto design </docs/technical_references/design_docs/tfm_crypto_design>`
+.. [12] :doc:`Crypto design </technical_references/design_docs/tfm_crypto_design>`
-.. [13] :doc:`TF-M build instruction </docs/technical_references/instructions/tfm_build_instruction>`
+.. [13] :doc:`TF-M build instruction </technical_references/instructions/tfm_build_instruction>`
--------------
diff --git a/docs/technical_references/design_docs/source_structure.rst b/docs/technical_references/design_docs/source_structure.rst
index b2de0dd..74219d0 100644
--- a/docs/technical_references/design_docs/source_structure.rst
+++ b/docs/technical_references/design_docs/source_structure.rst
@@ -6,7 +6,7 @@
:Contact: tf-m@lists.trustedfirmware.org
.. note::
- Reference the document :doc:`Glossary </docs/glossary>` for terms
+ Reference the document :doc:`Glossary </glossary>` for terms
and abbreviations.
************
diff --git a/docs/technical_references/design_docs/symmetric_initial_attest.rst b/docs/technical_references/design_docs/symmetric_initial_attest.rst
index 2e3e80c..673758e 100644
--- a/docs/technical_references/design_docs/symmetric_initial_attest.rst
+++ b/docs/technical_references/design_docs/symmetric_initial_attest.rst
@@ -588,9 +588,9 @@
.. [1] `PSA Attestation API 1.0 (ARM IHI 0085) <https://developer.arm.com/-/media/Files/pdf/PlatformSecurityArchitecture/Implement/IHI0085-PSA_Attestation_API-1.0.2.pdf?revision=eef78753-c77e-4b24-bcf0-65596213b4c1&la=en&hash=E5E0353D612077AFDCE3F2F3708A50C77A74B2A3>`_
-.. [2] :doc:`Trusted Firmware-M Profile Small Design </docs/technical_references/design_docs/profiles/tfm_profile_small>`
+.. [2] :doc:`Trusted Firmware-M Profile Small Design </technical_references/design_docs/profiles/tfm_profile_small>`
-.. [3] :doc:`Initial Attestation Service Integration Guide </docs/integration_guide/services/tfm_attestation_integration_guide>`
+.. [3] :doc:`Initial Attestation Service Integration Guide </integration_guide/services/tfm_attestation_integration_guide>`
.. [4] `HMAC: Keyed-Hashing for Message Authentication <https://tools.ietf.org/html/rfc2104>`_
diff --git a/docs/technical_references/design_docs/tfm_crypto_design.rst b/docs/technical_references/design_docs/tfm_crypto_design.rst
index 5d8484b..7176556 100644
--- a/docs/technical_references/design_docs/tfm_crypto_design.rst
+++ b/docs/technical_references/design_docs/tfm_crypto_design.rst
@@ -94,7 +94,7 @@
| | The prefix used for the PSA API symbols of the Mbed Crypto | |
| | library is chosen to be ``mbedcrypto__``. | |
+-----------------------------+---------------------------------------------------------------+----------------------------------------------------------------------+
- | Documentation | The integration guide contains the description of the TF-M | ``./docs/user_guides/services/tfm_crypto_integration_guide.rst`` |
+ | Documentation | The integration guide contains the description of the TF-M | ``./user_guides/services/tfm_crypto_integration_guide.rst`` |
| | Crypto service modules and interfaces. | |
+-----------------------------+---------------------------------------------------------------+----------------------------------------------------------------------+
diff --git a/docs/technical_references/instructions/documentation_generation.rst b/docs/technical_references/instructions/documentation_generation.rst
index 219418c..b99b0b1 100644
--- a/docs/technical_references/instructions/documentation_generation.rst
+++ b/docs/technical_references/instructions/documentation_generation.rst
@@ -83,7 +83,7 @@
Build TF-M Reference Manual
***************************
-The Reference Manual will be generated in the ``build_docs/docs/reference_manual``.
+The Reference Manual will be generated in the ``build_docs/reference_manual``.
.. tabs::
@@ -107,7 +107,7 @@
Build TF-M User Guide
*********************
-The User Manual will be available under the directory ``build_docs/docs/user_guide``.
+The User Manual will be available under the directory ``build_docs/user_guide``.
.. tabs::
diff --git a/docs/technical_references/instructions/run_tfm_examples_on_arm_platforms.rst b/docs/technical_references/instructions/run_tfm_examples_on_arm_platforms.rst
index 10065d8..e9f3acb 100644
--- a/docs/technical_references/instructions/run_tfm_examples_on_arm_platforms.rst
+++ b/docs/technical_references/instructions/run_tfm_examples_on_arm_platforms.rst
@@ -4,7 +4,7 @@
Instructions for how to run TF-M and example test application on Arm platforms.
Follow :doc:`build instruction <tfm_build_instruction>` to build the binaries.
-Follow :doc:`secure boot </docs/technical_references/design_docs/tfm_secure_boot>` to build the
+Follow :doc:`secure boot </technical_references/design_docs/tfm_secure_boot>` to build the
binaries with or without BL2 bootloader.
****************************************************************
@@ -567,7 +567,7 @@
Firmware upgrade and image validation with BL2 bootloader
=========================================================
High level operation of BL2 bootloader and instructions for testing firmware
-upgrade is described in :doc:`secure boot </docs/technical_references/design_docs/tfm_secure_boot>`.
+upgrade is described in :doc:`secure boot </technical_references/design_docs/tfm_secure_boot>`.
--------------
diff --git a/docs/technical_references/instructions/tfm_build_instruction.rst b/docs/technical_references/instructions/tfm_build_instruction.rst
index 4f700db..5e34af5 100644
--- a/docs/technical_references/instructions/tfm_build_instruction.rst
+++ b/docs/technical_references/instructions/tfm_build_instruction.rst
@@ -2,7 +2,7 @@
Build instructions
##################
Please make sure you have all required software installed as explained in the
-:doc:`TF-M getting started </docs/getting_started/tfm_getting_started>`.
+:doc:`TF-M getting started </getting_started/tfm_getting_started>`.
****************
TF-M build steps
@@ -25,13 +25,13 @@
``trusted-firmware-m`` would be referenced as ``<TF-M base folder>`` and
its parent, the ``<base folder>``. Dependency management is now handled by
cmake. If you wish to alter this behaviour, see
-:ref:`docs/technical_references/instructions/tfm_build_instruction:Manual
+:ref:`technical_references/instructions/tfm_build_instruction:Manual
dependency management`
.. Note::
- For building with Armclang compiler version 6.10.0+, please follow the note
- in :doc:`TF-M getting started </docs/getting_started/tfm_getting_started>`.
+ in :doc:`TF-M getting started </getting_started/tfm_getting_started>`.
- For building with the IAR toolchain, please see the notes in
:doc:`IAR software requirements <tfm_build_instruction_iar>`