aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeonardo Sandoval <leonardo.sandoval@linaro.org>2021-02-03 16:32:14 -0600
committerAnton Komlev <Anton.Komlev@arm.com>2021-04-29 10:38:18 +0200
commit9835014b67c394ed36b04621b456d7558f4d42cf (patch)
tree26533c49de9747313e7b449651a764ddac683e3f
parent528be45460d3b224b81225d1575f6cf1fb108b32 (diff)
downloadtrusted-firmware-m-9835014b67c394ed36b04621b456d7558f4d42cf.tar.gz
docs: simplify 'cd'ing into TF-M folder
Currently docs use two 'cd' commands to move to the TF-M folder (1. move to base folder 2. move to TF-M folder). This patch simplifies to a single 'cd' command, moving directly to TF-M base folder. Signed-off-by: Leonardo Sandoval <leonardo.sandoval@linaro.org> Change-Id: I8d67b73d749962672aca4b351ae5b18efb38283e
-rw-r--r--docs/getting_started/tfm_build_instruction.rst37
-rw-r--r--docs/getting_started/tfm_build_instruction_iar.rst12
2 files changed, 19 insertions, 30 deletions
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst
index 453d1d9ad..23220a611 100644
--- a/docs/getting_started/tfm_build_instruction.rst
+++ b/docs/getting_started/tfm_build_instruction.rst
@@ -19,8 +19,11 @@ Getting the source-code
cd <base folder>
git clone https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git
-Dependency management is now handled by cmake. If you wish to alter this
-behaviour, see :ref:`docs/getting_started/tfm_build_instruction:Manual
+To simplify documentation commands, the new created repository under
+``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
dependency management`
.. Note::
@@ -257,8 +260,7 @@ Example: building TF-M for AN521 platform using GCC:
====================================================
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake
cmake --build cmake_build -- install
@@ -266,8 +268,7 @@ Alternately using traditional cmake syntax
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake
@@ -292,8 +293,7 @@ features are enabled.
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DTEST_S=ON -DTEST_NS=ON
cmake --build cmake_build -- install
@@ -301,8 +301,7 @@ Alternately using traditional cmake syntax
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DTEST_S=ON -DTEST_NS=ON
@@ -330,8 +329,7 @@ tests for the Crypto service:
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DTEST_PSA_API=CRYPTO
cmake --build cmake_build -- install
@@ -339,8 +337,7 @@ Alternately using traditional cmake syntax
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DTEST_PSA_API=CRYPTO
@@ -358,8 +355,7 @@ compliance test. This support is controlled by the TEST_PSA_API variable:
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
cmake --build cmake_build -- install
@@ -367,8 +363,7 @@ Alternately using traditional cmake syntax
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DTEST_PSA_API=IPC -DTFM_PSA_API=ON
@@ -545,8 +540,7 @@ With new cmake syntax
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
cmake --build cmake_build -- install
@@ -554,8 +548,7 @@ Alternately using traditional cmake syntax
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
diff --git a/docs/getting_started/tfm_build_instruction_iar.rst b/docs/getting_started/tfm_build_instruction_iar.rst
index 2ee919656..a32048836 100644
--- a/docs/getting_started/tfm_build_instruction_iar.rst
+++ b/docs/getting_started/tfm_build_instruction_iar.rst
@@ -27,8 +27,7 @@ Example: building TF-M for AN521 platform using IAR:
====================================================
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_IARARM.cmake
cmake --build cmake_build -- install
@@ -36,8 +35,7 @@ Alternately using traditional cmake syntax
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_IARARM.cmake
@@ -48,8 +46,7 @@ Regression Tests for the AN521 target platform
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_IARARM.cmake -DTEST_S=ON -DTEST_NS=ON
cmake --build cmake_build -- install
@@ -57,8 +54,7 @@ Alternately using traditional cmake syntax
.. code-block:: bash
- cd <base folder>
- cd trusted-firmware-m
+ cd <TF-M base folder>
mkdir cmake_build
cd cmake_build
cmake .. -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=../toolchain_IARARM.cmake -DTEST_S=ON -DTEST_NS=ON