docs: Add cross references in userguide
This patch adds necessary cross references to CBMC and Cppcheck
application note from build examples and getting started guides.
The contribution guide is also enhanced to add notes about static
analysis as part of the contribution workflow.
Some minor corrections are also made in the cppcheck application
note.
Signed-off-by: Soby Mathew <soby.mathew@arm.com>
Change-Id: I67fe84b154f14dd49152862b5bdd4402ddb88881
diff --git a/docs/getting_started/build-options.rst b/docs/getting_started/build-options.rst
index ecb32c1..03fa3c1 100644
--- a/docs/getting_started/build-options.rst
+++ b/docs/getting_started/build-options.rst
@@ -100,19 +100,25 @@
8. Perform a Cppcheck static analysis:
+Refer to :ref:`Cppcheck Application Note` for details on installing and running cppcheck
+static analysis.
+
.. code-block:: bash
cmake -DRMM_CONFIG=fvp_defcfg -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -S ${RMM_SOURCE_DIR} -B ${RMM_BUILD_DIR}
cmake --build ${RMM_BUILD_DIR} -- cppcheck
- cat ${BUILD_DIR}/tools/cppcheck/cppcheck.xml
+ cat ${RMM_BUILD_DIR}/tools/cppcheck/cppcheck.xml
9. Perform a Cppcheck static analysis with MISRA:
+Refer to :ref:`Cppcheck Application Note` for details on installing and running cppcheck
+static analysis.
+
.. code-block:: bash
cmake -DRMM_CONFIG=fvp_defcfg -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -S ${RMM_SOURCE_DIR} -B ${RMM_BUILD_DIR}
cmake --build ${RMM_BUILD_DIR} -- cppcheck-misra
- cat ${BUILD_DIR}/tools/cppcheck/cppcheck_misra.xml
+ cat ${RMM_BUILD_DIR}/tools/cppcheck/cppcheck_misra.xml
10. Perform a checkpatch analysis:
@@ -244,6 +250,8 @@
cmake -DRMM_CONFIG=host_defcfg -DHOST_VARIANT=host_cbmc -S ${RMM_SOURCE_DIR} -B ${RMM_BUILD_DIR}
cmake --build ${RMM_BUILD_DIR} -- cbmc-coverage cbmc-analysis cbmc-assert
+Refer to :ref:`CBMC` Application Note for details on installing and running CBMC.
+
.. _build_options_table:
###################