Docs: Rearrange TF-M building instructions
- move the building instructios to a dedicated folder, reflecting main TOC
- adjust links in the documentation
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: I335de95061938d619a47cd813020121809e1459b
diff --git a/docs/technical_references/instructions/documentation_generation.rst b/docs/building/documentation_generation.rst
similarity index 100%
rename from docs/technical_references/instructions/documentation_generation.rst
rename to docs/building/documentation_generation.rst
diff --git a/docs/technical_references/instructions/run_tfm_examples_on_arm_platforms.rst b/docs/building/run_tfm_examples_on_arm_platforms.rst
similarity index 100%
rename from docs/technical_references/instructions/run_tfm_examples_on_arm_platforms.rst
rename to docs/building/run_tfm_examples_on_arm_platforms.rst
diff --git a/docs/technical_references/instructions/tfm_build_instruction.rst b/docs/building/tfm_build_instruction.rst
similarity index 99%
rename from docs/technical_references/instructions/tfm_build_instruction.rst
rename to docs/building/tfm_build_instruction.rst
index de2744e..6d9f50a 100644
--- a/docs/technical_references/instructions/tfm_build_instruction.rst
+++ b/docs/building/tfm_build_instruction.rst
@@ -1,6 +1,7 @@
##################
Build instructions
##################
+
Please make sure you have all required software installed as explained in the
:doc:`TF-M getting started </getting_started/tfm_getting_started>`.
The additional building materials you can find in the following links:
@@ -8,9 +9,9 @@
.. toctree::
:maxdepth: 1
- IAR toolchain <tfm_build_instruction_iar>
Run TF-M examples <run_tfm_examples_on_arm_platforms>
- Building documentation <documentation_generation>
+ Building the documentation <documentation_generation>
+ IAR toolchain <tfm_build_instruction_iar>
****************
TF-M build steps
@@ -33,8 +34,7 @@
``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:`technical_references/instructions/tfm_build_instruction:Manual
-dependency management`
+:ref:`building/tfm_build_instruction:Manual dependency management`
.. Note::
diff --git a/docs/technical_references/instructions/tfm_build_instruction_iar.rst b/docs/building/tfm_build_instruction_iar.rst
similarity index 100%
rename from docs/technical_references/instructions/tfm_build_instruction_iar.rst
rename to docs/building/tfm_build_instruction_iar.rst
diff --git a/docs/contributing/contributing_process.rst b/docs/contributing/contributing_process.rst
index 3eb6cdf..04cea4c 100644
--- a/docs/contributing/contributing_process.rst
+++ b/docs/contributing/contributing_process.rst
@@ -20,7 +20,7 @@
- Clone the TF-M code on your own machine from `TF-M git repository
<https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git>`_.
- Follow the :doc:`TF-M getting started </getting_started/tfm_getting_started>`,
- :doc:`Build Instructions </technical_references/instructions/tfm_build_instruction>` and
+ :doc:`Build Instructions </building/tfm_build_instruction>`
:doc:`Coding Guide </contributing/coding_guide>` for the TF-M project.
- Make your changes in logical chunks to help reviewers. Each commit should
be a separate review and either work properly or be squashed after the
diff --git a/docs/getting_started/tfm_getting_started.rst b/docs/getting_started/tfm_getting_started.rst
index 128b05a..dad3dc6 100644
--- a/docs/getting_started/tfm_getting_started.rst
+++ b/docs/getting_started/tfm_getting_started.rst
@@ -25,9 +25,9 @@
- Follow the this guide to set up and check your environment.
- Follow the
- :doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`
+ :doc:`Build instructions </building/tfm_build_instruction>`
to compile and build the TF-M source.
- - Follow the :doc:`Run TF-M examples on Arm platforms </technical_references/instructions/run_tfm_examples_on_arm_platforms>`
+ - Follow the :doc:`Run TF-M examples on Arm platforms </building/run_tfm_examples_on_arm_platforms>`
for information on running the example.
To port TF-M to a another system or OS, follow the
@@ -454,10 +454,10 @@
Here are some next steps for exploring TF-M:
- - Detailed :doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`.
- - :doc:`IAR Build instructions </technical_references/instructions/tfm_build_instruction_iar>`.
- - Try other :doc:`Samples and Demos </technical_references/instructions/run_tfm_examples_on_arm_platforms>`.
- - :doc:`Documentation generation </technical_references/instructions/documentation_generation>`.
+ - Detailed :doc:`Build instructions </building/tfm_build_instruction>`.
+ - :doc:`IAR Build instructions </building/tfm_build_instruction_iar>`.
+ - Try other :doc:`Samples and Demos </building/run_tfm_examples_on_arm_platforms>`.
+ - :doc:`Documentation generation </building/documentation_generation>`.
--------------
diff --git a/docs/index.rst b/docs/index.rst
index 8fc23ff..add4ec2 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -86,7 +86,7 @@
:hidden:
Platform Selection<platform/ext/index>
- Building <technical_references/instructions/tfm_build_instruction>
+ building/tfm_build_instruction
integration_guide/index
technical_references/design_docs/index
Tools <tools/index>
diff --git a/docs/integration_guide/index.rst b/docs/integration_guide/index.rst
index 703c4f7..b68558c 100644
--- a/docs/integration_guide/index.rst
+++ b/docs/integration_guide/index.rst
@@ -23,12 +23,12 @@
*****************
How to build TF-M
*****************
-Follow the :doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`.
+Follow the :doc:`Build instructions </building/tfm_build_instruction>`.
********************************************************
How to export files for building non-secure applications
********************************************************
-Explained in the :doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`.
+Explained in the :doc:`Build instructions </building/tfm_build_instruction>`.
*************************
How to add a new platform
diff --git a/docs/integration_guide/os_migration_guide_armv8m.rst b/docs/integration_guide/os_migration_guide_armv8m.rst
index 198df9d..8c5b400 100644
--- a/docs/integration_guide/os_migration_guide_armv8m.rst
+++ b/docs/integration_guide/os_migration_guide_armv8m.rst
@@ -17,7 +17,7 @@
- If the OS manipulates directly the Link Register, the default Link Register
value used in Handler mode transitions needs to be differentiated between
Secure and Non Secure builds, i.e. ``0xFD`` and ``0xBC``, respectively.
-- If the OS manages the non-secure client identification, pelase check the
+- If the OS manages the non-secure client identification, please check the
:doc:`Non-secure Client Extension Integration Guide </integration_guide/non-secure_client_extension_integration_guide>`.
--------------
diff --git a/docs/integration_guide/platform/porting_TFM_to_a_new_hardware.rst b/docs/integration_guide/platform/porting_TFM_to_a_new_hardware.rst
index 1a5f63b..e7a330d 100644
--- a/docs/integration_guide/platform/porting_TFM_to_a_new_hardware.rst
+++ b/docs/integration_guide/platform/porting_TFM_to_a_new_hardware.rst
@@ -19,7 +19,7 @@
======================
Make sure you have a working build environnement and that you can build
TF-M on AN521 following the
-:doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`.
+:doc:`Build instructions </building/tfm_build_instruction>`.
Toolchains and software requirements
====================================
@@ -59,7 +59,7 @@
#. Running the regression tests
- - See :doc:`Running TF-M on Arm platforms </technical_references/instructions/run_tfm_examples_on_arm_platforms>`
+ - See :doc:`Running TF-M on Arm platforms </building/run_tfm_examples_on_arm_platforms>`
as an example
diff --git a/docs/integration_guide/services/tfm_attestation_integration_guide.rst b/docs/integration_guide/services/tfm_attestation_integration_guide.rst
index 244ed5d..0bd907d 100644
--- a/docs/integration_guide/services/tfm_attestation_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_attestation_integration_guide.rst
@@ -625,9 +625,9 @@
- Build TF-M with any of the ``ConfigRegression*.cmake`` build configurations
for MPS2 AN521 platform. More info in
- :doc:`tfm_build_instruction </technical_references/instructions/tfm_build_instruction>`.
+ :doc:`tfm_build_instruction </building/tfm_build_instruction>`.
- Lunch FVP model in DS-5. More info in
- :doc:`Run TF-M examples on Arm platforms </technical_references/instructions/run_tfm_examples_on_arm_platforms>`.
+ :doc:`Run TF-M examples on Arm platforms </building/run_tfm_examples_on_arm_platforms>`.
- Set a breakpoint in ``test/secure_fw/suites/attestation/attest_token_test.c``
in ``decode_test_internal(..)`` after the ``token_main_alt(..)`` returned,
i.e. on line 859. Execute the code in the model until the breakpoint hits
diff --git a/docs/platform/ext/target/arm/mps3/an547/README.rst b/docs/platform/ext/target/arm/mps3/an547/README.rst
index f0640c8..7506703 100644
--- a/docs/platform/ext/target/arm/mps3/an547/README.rst
+++ b/docs/platform/ext/target/arm/mps3/an547/README.rst
@@ -4,7 +4,7 @@
Building TF-M
-------------
-Follow the instructions in :doc:`Building instructions </technical_references/instructions/tfm_build_instruction>`.
+Follow the instructions in :doc:`Building instructions </building/tfm_build_instruction>`.
Build instructions with platform name: arm/mps3/an547
``-DTFM_PLATFORM=arm/mps3/an547``
diff --git a/docs/platform/ext/target/arm/mps3/an552/README.rst b/docs/platform/ext/target/arm/mps3/an552/README.rst
index d696bce..080f887 100644
--- a/docs/platform/ext/target/arm/mps3/an552/README.rst
+++ b/docs/platform/ext/target/arm/mps3/an552/README.rst
@@ -4,7 +4,7 @@
Building TF-M
-------------
-Follow the instructions in :doc:`Building instructions </technical_references/instructions/tfm_build_instruction>`.
+Follow the instructions in :doc:`Building instructions </building/tfm_build_instruction>`.
Build instructions with platform name: arm/mps3/an552
``-DTFM_PLATFORM=arm/mps3/an552``
diff --git a/docs/platform/ext/target/arm/mps3/corstone310_fvp/README.rst b/docs/platform/ext/target/arm/mps3/corstone310_fvp/README.rst
index b1fa793..7b9f268 100644
--- a/docs/platform/ext/target/arm/mps3/corstone310_fvp/README.rst
+++ b/docs/platform/ext/target/arm/mps3/corstone310_fvp/README.rst
@@ -15,7 +15,7 @@
Building TF-M
-------------
-Follow the instructions in :doc:`Building instructions </technical_references/instructions/tfm_build_instruction>`.
+Follow the instructions in :doc:`Building instructions </building/tfm_build_instruction>`.
Build instructions with platform name: arm/mps3/corstone310_fvp
``-DTFM_PLATFORM=arm/mps3/corstone310_fvp``
diff --git a/docs/platform/ext/target/arm/rss/readme.rst b/docs/platform/ext/target/arm/rss/readme.rst
index 107d7af..413f135 100644
--- a/docs/platform/ext/target/arm/rss/readme.rst
+++ b/docs/platform/ext/target/arm/rss/readme.rst
@@ -23,7 +23,7 @@
Building TF-M
-------------
-Follow the instructions in :doc:`Build instructions </technical_references/instructions/tfm_build_instruction>`.
+Follow the instructions in :doc:`Build instructions </building/tfm_build_instruction>`.
Build TF-M with platform name: `arm/rss`
``-DTFM_PLATFORM=arm/rss``
diff --git a/docs/platform/ext/target/cypress/psoc64/cypress_psoc64_spec.rst b/docs/platform/ext/target/cypress/psoc64/cypress_psoc64_spec.rst
index 9902971..d786eb5 100644
--- a/docs/platform/ext/target/cypress/psoc64/cypress_psoc64_spec.rst
+++ b/docs/platform/ext/target/cypress/psoc64/cypress_psoc64_spec.rst
@@ -16,7 +16,7 @@
:doc:`TF-M getting started </getting_started/tfm_getting_started>`.
Please also make sure that all the source code are fetched by following
-:doc:`general building instruction </technical_references/instructions/tfm_build_instruction>`.
+:doc:`general building instruction </building/tfm_build_instruction>`.
Install CySecureTools or update it to the newest version (2.0.0 at the time of
writing)
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 dab5754..9bb4a02 100644
--- a/docs/technical_references/design_docs/profiles/tfm_profile_large.rst
+++ b/docs/technical_references/design_docs/profiles/tfm_profile_large.rst
@@ -470,7 +470,7 @@
.. [8] :doc:`ITS integration guide </integration_guide/services/tfm_its_integration_guide>`
-.. [9] :doc:`TF-M build instruction </technical_references/instructions/tfm_build_instruction>`
+.. [9] :doc:`TF-M build instruction </building/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 474548c..1b450d0 100644
--- a/docs/technical_references/design_docs/profiles/tfm_profile_medium.rst
+++ b/docs/technical_references/design_docs/profiles/tfm_profile_medium.rst
@@ -500,7 +500,7 @@
.. [ITS-INTEGRATE] :doc:`ITS integration guide </integration_guide/services/tfm_its_integration_guide>`
-.. [TFM-BUILD] :doc:`TF-M build instruction </technical_references/instructions/tfm_build_instruction>`
+.. [TFM-BUILD] :doc:`TF-M build instruction </building/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 9a47170..fef3dcc 100644
--- a/docs/technical_references/design_docs/profiles/tfm_profile_small.rst
+++ b/docs/technical_references/design_docs/profiles/tfm_profile_small.rst
@@ -715,7 +715,7 @@
.. [12] :doc:`Crypto design </technical_references/design_docs/tfm_crypto_design>`
-.. [13] :doc:`TF-M build instruction </technical_references/instructions/tfm_build_instruction>`
+.. [13] :doc:`TF-M build instruction </building/tfm_build_instruction>`
.. [14] `PSA Cryptography API 1.0 <https://developer.arm.com/documentation/ihi0086/a/?lang=en>`_