Docs: Error Fix
Various error fixes.
Change-Id: I73f3f32396c1b6fec059f22304d278ba7508338e
Signed-off-by: Elena Uziunaite <elena.uziunaite@arm.com>
diff --git a/docs/code-size-analyze-tool.rst b/docs/code-size-analyze-tool.rst
index e9abcf2..c556962 100644
--- a/docs/code-size-analyze-tool.rst
+++ b/docs/code-size-analyze-tool.rst
@@ -36,9 +36,9 @@
pip install mysqlclient XlsxWriter windows-curses
-**********************
-Code size analyze tool
-**********************
+*****
+Usage
+*****
The commands of code size analyze tool usage are:
diff --git a/docs/fih_test_tool.rst b/docs/fih_test_tool.rst
index 0209219..fadedf0 100644
--- a/docs/fih_test_tool.rst
+++ b/docs/fih_test_tool.rst
@@ -71,18 +71,19 @@
BUILD_DIR variables / arguments correctly.
For example:
-```
-cd <TFM_DIR>
-mkdir build
-cd build
-<Path to>/fih_test -p LOW
-# Test with certain function
-<Path to>/fih_test -p LOW -l 2 -f "tfm_hal_set_up_static_boundaries"
+.. code-block:: console
-# Build the AXF file again if the source code has been changed
-<Path to>/fih_test -p LOW -l 2 -r
-```
+ cd <TFM_DIR>
+ mkdir build
+ cd build
+ <Path to>/fih_test -p LOW
+
+ # Test with certain function
+ <Path to>/fih_test -p LOW -l 2 -f "tfm_hal_set_up_static_boundaries"
+
+ # Build the AXF file again if the source code has been changed
+ <Path to>/fih_test -p LOW -l 2 -r
Fault types
=====================
diff --git a/docs/index.rst b/docs/index.rst
index a4b0190..dea768a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,8 +2,6 @@
Trusted Firmware-M Tools
################################
-.. raw:: html
-
.. toctree::
:caption: Overview
:titlesonly:
diff --git a/docs/irq_test_tool.rst b/docs/irq_test_tool.rst
index 1b3b04f..28d40b8 100644
--- a/docs/irq_test_tool.rst
+++ b/docs/irq_test_tool.rst
@@ -275,9 +275,10 @@
Before running the example, the breakpoints.json needs to be generated from the
TF-M source tree:
-.. code:: shell
- $ cd tools/irq_test/
- $ python3 tools/generate_breakpoints.py ../.. example/breakpoints.json
+.. code-block:: console
+
+ $ cd tools/irq_test/
+ $ python3 tools/generate_breakpoints.py ../.. example/breakpoints.json
The example also require the regression test suite being present in the TF-M
binary, so either ``ConfigRegressionIPC.cmake`` or ``ConfigRegression.cmake``
diff --git a/docs/profiling.rst b/docs/profiling.rst
index 2e081c9..e913b75 100644
--- a/docs/profiling.rst
+++ b/docs/profiling.rst
@@ -100,6 +100,7 @@
Users can call macro ``PROF_TIMING_LOG()`` logs the counter value.
.. code-block:: c
+
PROF_TIMING_LOG(topic_id, cp_id);
+------------+--------------------------------------------------------------+
@@ -256,9 +257,7 @@
If the profiling case requires extra out-of-tree secure partition build, the
paths of extra partitions and manifest list file shall be appended in
``TFM_EXTRA_PARTITION_PATHS`` and ``TFM_EXTRA_MANIFEST_LIST_FILES``. Refer to
- `Adding Secure Partition`_.
-
-.. _Adding Secure Partition: https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/tree/docs/integration_guide/services/tfm_secure_partition_addition.rst
+ :doc:`Adding Secure Partition<TF-M:integration_guide/services/tfm_secure_partition_addition>`.
--------------
diff --git a/docs/squad-dashboard.rst b/docs/squad-dashboard.rst
index 0bf6fad..4cfcb1a 100644
--- a/docs/squad-dashboard.rst
+++ b/docs/squad-dashboard.rst
@@ -47,9 +47,7 @@
- MinSizeProfileS (DefaultProfileS with MinsizeRel Cmake type)
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:`Migration from legacy buildsystem`.
+used.
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/static_checks/git_hooks.rst b/docs/static_checks/git_hooks.rst
index a1c1407..84f8034 100644
--- a/docs/static_checks/git_hooks.rst
+++ b/docs/static_checks/git_hooks.rst
@@ -44,7 +44,8 @@
By default the reference code assumes the standard directory structure for
TF-M and dependencies.
-.. code-block:: bash
+.. code-block:: console
+
└── dev-dir
├── tf-m
├── tf-m-tools
diff --git a/docs/tf_fuzz.md b/docs/tf_fuzz.md
index d54748c..bc4387e 100644
--- a/docs/tf_fuzz.md
+++ b/docs/tf_fuzz.md
@@ -12,6 +12,7 @@
TF-Fuzz is a TF-M fuzzing tool, at the PSA-call level. At the time of writing
this at least, presentations available at:
+
https://www.trustedfirmware.org/docs/TF-M_Fuzzing_Tool_TFOrg.pdf
https://zoom.us/rec/share/1dxZcZit111IadadyFqFU7IoP5X5aaa8gXUdr_UInxmMbyLzEqEmXQdx79-IWQ9p
(These presentation materials may not be viewable by all parties.)
@@ -19,11 +20,12 @@
--------------------------------------------------------------------------------
To build TF-Fuzz, simply type "make" in this directory. Executable, called
-"tfz," is placed in this directory.
+"tfz", is placed in this directory.
To run tfz, two environment variables must first be assigned. In bash syntax:
-export TF_FUZZ_LIB_DIR=<path to this TF-M installation>/tf-m-tools/tf_fuzz/lib
-export TF_FUZZ_BPLATE=tfm_boilerplate.txt
+
+ export TF_FUZZ_LIB_DIR=<path to this TF-M installation>/tf-m-tools/tf_fuzz/lib
+ export TF_FUZZ_BPLATE=tfm_boilerplate.txt
Examples of usage can be found in the demo directory.