diff options
author | Subhasish Ghosh <subhasish.ghosh@arm.com> | 2021-04-08 20:21:20 +0100 |
---|---|---|
committer | Subhasish Ghosh <subhasish.ghosh@arm.com> | 2021-04-30 09:09:12 +0100 |
commit | bc8493014af69c9a5a568426362bce7f94fadc9e (patch) | |
tree | f726eb8bbe3377cd409c04db71f9b380d4a67f0b /docs/getting_started/tfm_build_instruction.rst | |
parent | 99b069f8dc82c682de4a8c8d4b9f0b3c97f1bef4 (diff) | |
download | trusted-firmware-m-bc8493014af69c9a5a568426362bce7f94fadc9e.tar.gz |
docs: update build and sw requirement docs
Updated build and software requirements documentation
1. Simplified Linux and Windows build environment setup
2. Updated tools version dependencies
3. Removed some docs compilation warnings
Signed-off-by: Subhasish Ghosh <subhasish.ghosh@arm.com>
Change-Id: Ia0655e509d4a6424068b6113cc8a80f4b93fe8bd
Diffstat (limited to 'docs/getting_started/tfm_build_instruction.rst')
-rw-r--r-- | docs/getting_started/tfm_build_instruction.rst | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst index 9779d09006..403fccd501 100644 --- a/docs/getting_started/tfm_build_instruction.rst +++ b/docs/getting_started/tfm_build_instruction.rst @@ -253,12 +253,16 @@ cmake. TF-M build examples ******************* +.. Note:: + By default, CMAKE_BUILD_TYPE is set to Release, for debug support change + this to Debug. See below for an example. + Example: building TF-M for AN521 platform using GCC: ==================================================== .. code-block:: bash cd <TF-M base folder> - cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake + cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake -DCMAKE_BUILD_TYPE=Debug cmake --build cmake_build -- install Alternately using traditional cmake syntax @@ -286,6 +290,7 @@ to explicitly include it. In case other toolchain is required, i.e. ARM Clang, s specify in the command line .. code-block:: bash + cd <TF-M base folder> cmake -S . -B cmake_build -DTFM_PLATFORM=mps2/an521 -DTFM_TOOLCHAIN_FILE=toolchain_ARMCLANG.cmake -DTEST_S=ON -DTEST_NS=ON cmake --build cmake_build -- install @@ -323,7 +328,7 @@ PSA API tests simultaneously is **not** supported. The value of the TEST_PSA_API variable is the suite to be run. -.. code-block:: +.. code-block:: bash -DTEST_PSA_API=INTERNAL_TRUSTED_STORAGE -DTEST_PSA_API=PROTECTED_STORAGE @@ -356,7 +361,7 @@ Build for PSA FF (IPC) compliance tests The build system provides support for building and integrating the PSA FF compliance test. This support is controlled by the TEST_PSA_API variable: -.. code-block:: +.. code-block:: bash -DTEST_PSA_API=IPC |