Docs: Move build instruction and user guide into technical reference
Move build instruction document and user guide document from getting
started into technical references folder. Rename 'tfm_user_guide.rst'
to 'tfm_run_instruction.rst'. This will make the document structure
more clear for readers.
Signed-off-by: Summer Qin <summer.qin@arm.com>
Change-Id: I69d46151f2cb97c828c1b82775ffd1af9032ed45
diff --git a/docs/contributing/contributing_process.rst b/docs/contributing/contributing_process.rst
index b017c63..002df7e 100644
--- a/docs/contributing/contributing_process.rst
+++ b/docs/contributing/contributing_process.rst
@@ -27,7 +27,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:`SW Requirements </docs/getting_started/tfm_sw_requirement>`,
- :doc:`Build Instructions </docs/getting_started/tfm_build_instruction>` and
+ :doc:`Build Instructions </docs/technical_references/instructions/tfm_build_instruction>` and
:doc:`Coding Guide </docs/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/contributing/tfm_design_proposal_process.rst b/docs/contributing/tfm_design_proposal_process.rst
index fcc2be9..49ff7e7 100644
--- a/docs/contributing/tfm_design_proposal_process.rst
+++ b/docs/contributing/tfm_design_proposal_process.rst
@@ -71,7 +71,7 @@
For information on what tools are needed please refer to
:doc:`sw requirements </docs/getting_started/tfm_sw_requirement>`. To see how to get
a local copy of the TF-M repository please see
-:doc:`build instructions </docs/getting_started/tfm_build_instruction>`
+:doc:`build instructions </docs/technical_references/instructions/tfm_build_instruction>`
Process steps
-------------
diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst
index 2952f19..9ddb2d0 100644
--- a/docs/getting_started/index.rst
+++ b/docs/getting_started/index.rst
@@ -6,9 +6,6 @@
:numbered:
tfm_sw_requirement
- tfm_build_instruction
- tfm_build_instruction_iar
- tfm_user_guide
--------------
diff --git a/docs/getting_started/tfm_sw_requirement.rst b/docs/getting_started/tfm_sw_requirement.rst
index e720647..03f5629 100644
--- a/docs/getting_started/tfm_sw_requirement.rst
+++ b/docs/getting_started/tfm_sw_requirement.rst
@@ -72,7 +72,7 @@
https://cmake.org/files.
CMake handles all external dependencies, but if you wish to alter this
-behaviour, see :ref:`docs/getting_started/tfm_build_instruction:Manual
+behaviour, see :ref:`docs/technical_references/instructions/tfm_build_instruction:Manual
dependency management`
********
@@ -150,7 +150,7 @@
curl -L http://sourceforge.net/projects/plantuml/files/plantuml.jar/download --output ~/plantuml/plantuml.jar
Clone the TF-M Sources
-(see :ref:`docs/getting_started/tfm_build_instruction:Getting the source-code`),
+(see :ref:`docs/technical_references/instructions/tfm_build_instruction:Getting the source-code`),
then
.. code-block:: bash
@@ -241,7 +241,7 @@
Download and install the required tools from above.
Clone the TF-M Sources
-(see :ref:`docs/getting_started/tfm_build_instruction:Getting the source-code`),
+(see :ref:`docs/technical_references/instructions/tfm_build_instruction:Getting the source-code`),
then
.. code-block:: bash
diff --git a/docs/integration_guide/SQUAD_Dashboard.rst b/docs/integration_guide/SQUAD_Dashboard.rst
index 5022ed6..5da74a0 100644
--- a/docs/integration_guide/SQUAD_Dashboard.rst
+++ b/docs/integration_guide/SQUAD_Dashboard.rst
@@ -49,7 +49,7 @@
For all of the configurations, tests are disabled and the release build type is
used. For more details about the configurations and how the rest of the options
are set for each of them, see
-:ref:`Build instructions </docs/getting_started/tfm_build_instruction:Migration from legacy buildsystem>`.
+:ref:`docs/technical_references/instructions/tfm_build_instruction:Migration from legacy buildsystem`.
More configurations and metrics could be added to the dashboard in the future.
For each metric sent to the SQUAD dashboard, the metric must be linked with the
diff --git a/docs/integration_guide/services/tfm_attestation_integration_guide.rst b/docs/integration_guide/services/tfm_attestation_integration_guide.rst
index dfbcfe7..0f2e24b 100644
--- a/docs/integration_guide/services/tfm_attestation_integration_guide.rst
+++ b/docs/integration_guide/services/tfm_attestation_integration_guide.rst
@@ -639,9 +639,9 @@
- Build TF-M with any of the ``ConfigRegression*.cmake`` build configurations
for MPS2 AN521 platform. More info in
- :doc:`tfm_build_instruction </docs/getting_started/tfm_build_instruction>`.
+ :doc:`tfm_build_instruction </docs/technical_references/instructions/tfm_build_instruction>`.
- Lunch FVP model in DS-5. More info in
- :doc:`tfm_user_guide </docs/getting_started/tfm_user_guide>`.
+ :doc:`tfm_run_instruction </docs/technical_references/instructions/tfm_run_instruction>`.
- Set a breakpoint in ``test/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/integration_guide/tfm_integration_guide.rst b/docs/integration_guide/tfm_integration_guide.rst
index f6807e1..ccf206f 100644
--- a/docs/integration_guide/tfm_integration_guide.rst
+++ b/docs/integration_guide/tfm_integration_guide.rst
@@ -7,12 +7,12 @@
*****************
How to build TF-M
*****************
-Follow the :doc:`Build instructions </docs/getting_started/tfm_build_instruction>`.
+Follow the :doc:`Build instructions </docs/technical_references/instructions/tfm_build_instruction>`.
********************************************************
How to export files for building non-secure applications
********************************************************
-Explained in the :doc:`Build instructions </docs/getting_started/tfm_build_instruction>`.
+Explained in the :doc:`Build instructions </docs/technical_references/instructions/tfm_build_instruction>`.
*************************
How to add a new platform
diff --git a/docs/introduction/readme.rst b/docs/introduction/readme.rst
index c90f8ce..a628879 100644
--- a/docs/introduction/readme.rst
+++ b/docs/introduction/readme.rst
@@ -87,10 +87,10 @@
- Follow the :doc:`SW requirements guide </docs/getting_started/tfm_sw_requirement>`
to set up your environment.
- Follow the
- :doc:`Build instructions </docs/getting_started/tfm_build_instruction>` to compile
- and build the TF-M source.
- - Follow the :doc:`User guide </docs/getting_started/tfm_user_guide>` for information
- on running the example.
+ :doc:`Build instructions </docs/technical_references/instructions/tfm_build_instruction>`
+ to compile and build the TF-M source.
+ - Follow the :doc:`Run TF-M examples on Arm platforms </docs/technical_references/instructions/tfm_run_instruction>`
+ for information on running the example.
To port TF-M to a another system or OS, follow the
:doc:`OS Integration Guide </docs/integration_guide/tfm_integration_guide>`
diff --git a/docs/technical_references/instructions/index.rst b/docs/technical_references/instructions/index.rst
new file mode 100644
index 0000000..19a6e43
--- /dev/null
+++ b/docs/technical_references/instructions/index.rst
@@ -0,0 +1,12 @@
+TF-M Detailed Instructions
+==========================
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ *
+
+--------------
+
+*Copyright (c) 2021, Arm Limited. All rights reserved.*
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/technical_references/instructions/tfm_build_instruction.rst
similarity index 97%
rename from docs/getting_started/tfm_build_instruction.rst
rename to docs/technical_references/instructions/tfm_build_instruction.rst
index f64528a..485d917 100644
--- a/docs/getting_started/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:`software requirements <tfm_sw_requirement>`.
+:doc:`software requirements </docs/getting_started/tfm_sw_requirement>`.
****************
TF-M build steps
@@ -23,13 +23,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/getting_started/tfm_build_instruction:Manual
+:ref:`docs/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:`software requirements <tfm_sw_requirement>`.
+ in :doc:`software requirements </docs/getting_started/tfm_sw_requirement>`.
- For building with the IAR toolchain, please see the notes in
:doc:`IAR software requirements <tfm_build_instruction_iar>`
@@ -396,8 +396,8 @@
Building the documentation
==========================
Please ensure the dependencies for building the documentation are installed
-as explained in the :doc:`software requirements <tfm_sw_requirement>`. The
-requirements to build the firmware, are only required when using the CMAKE
+as explained in the :doc:`software requirements </docs/getting_started/tfm_sw_requirement>`.
+The requirements to build the firmware, are only required when using the CMAKE
method
There are currently two ways of building the documentation:
diff --git a/docs/getting_started/tfm_build_instruction_iar.rst b/docs/technical_references/instructions/tfm_build_instruction_iar.rst
similarity index 100%
rename from docs/getting_started/tfm_build_instruction_iar.rst
rename to docs/technical_references/instructions/tfm_build_instruction_iar.rst
diff --git a/docs/getting_started/tfm_user_guide.rst b/docs/technical_references/instructions/tfm_run_instruction.rst
similarity index 98%
rename from docs/getting_started/tfm_user_guide.rst
rename to docs/technical_references/instructions/tfm_run_instruction.rst
index bd9ce91..965d3e9 100644
--- a/docs/getting_started/tfm_user_guide.rst
+++ b/docs/technical_references/instructions/tfm_run_instruction.rst
@@ -1,8 +1,7 @@
-##########
-User guide
-##########
-How to compile and run TF-M and example test application for CoreLink
-SSE-200 subsystem on the MPS2 board and on the Fast Model(FVP).
+##################################
+Run TF-M examples on Arm platforms
+##################################
+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/tfm_secure_boot>` to build the
@@ -31,8 +30,6 @@
================================================
Using FVP_MPS2_AEMv8M provided by `Arm Development Studio`_ 2019.1.
-
-
Example application and regression tests without BL2 bootloader
---------------------------------------------------------------
Add ``tfm_s.axf`` and ``tfm_ns.axf`` to symbol files in Debug Configuration
diff --git a/docs/technical_references/profiles/tfm_profile_large.rst b/docs/technical_references/profiles/tfm_profile_large.rst
index 89edd29..45e51f4 100644
--- a/docs/technical_references/profiles/tfm_profile_large.rst
+++ b/docs/technical_references/profiles/tfm_profile_large.rst
@@ -452,7 +452,7 @@
.. [8] :doc:`ITS integration guide </docs/integration_guide/services/tfm_its_integration_guide>`
-.. [9] :doc:`TF-M build instruction </docs/getting_started/tfm_build_instruction>`
+.. [9] :doc:`TF-M build instruction </docs/technical_references/instructions/tfm_build_instruction>`
--------------
diff --git a/docs/technical_references/profiles/tfm_profile_medium.rst b/docs/technical_references/profiles/tfm_profile_medium.rst
index ae24b98..6b384c7 100644
--- a/docs/technical_references/profiles/tfm_profile_medium.rst
+++ b/docs/technical_references/profiles/tfm_profile_medium.rst
@@ -482,7 +482,7 @@
.. [ITS-INTEGRATE] :doc:`ITS integration guide </docs/integration_guide/services/tfm_its_integration_guide>`
-.. [TFM-BUILD] :doc:`TF-M build instruction </docs/getting_started/tfm_build_instruction>`
+.. [TFM-BUILD] :doc:`TF-M build instruction </docs/technical_references/instructions/tfm_build_instruction>`
--------------
diff --git a/docs/technical_references/profiles/tfm_profile_small.rst b/docs/technical_references/profiles/tfm_profile_small.rst
index a97a1e1..17f6f49 100644
--- a/docs/technical_references/profiles/tfm_profile_small.rst
+++ b/docs/technical_references/profiles/tfm_profile_small.rst
@@ -640,7 +640,7 @@
.. [10] :doc:`Crypto design </docs/technical_references/tfm_crypto_design>`
-.. [11] :doc:`TF-M build instruction </docs/getting_started/tfm_build_instruction>`
+.. [11] :doc:`TF-M build instruction </docs/technical_references/instructions/tfm_build_instruction>`
--------------