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/getting-started.rst b/docs/getting_started/getting-started.rst
index b8c8f87..367b1d6 100644
--- a/docs/getting_started/getting-started.rst
+++ b/docs/getting_started/getting-started.rst
@@ -1,6 +1,8 @@
.. SPDX-License-Identifier: BSD-3-Clause
.. SPDX-FileCopyrightText: Copyright TF-RMM Contributors.
+.. _getting_started:
+
#############
Prerequisite
#############
@@ -28,12 +30,12 @@
arm64/AArch64 Ubuntu and other Linux distributions should also work fine,
provided that the necessary tools and libraries can be installed.
+.. _tool_dependencies:
+
##########################
Tool & Dependency overview
##########################
-.. _tool_dependencies:
-
The following tools are required to obtain and build |RMM|:
.. csv-table:: Tool dependencies
@@ -53,7 +55,7 @@
"docutils",">v2.38.0","Documentation"
"gcovr",">=v4.2","Tools(Coverage analysis)"
"CBMC",">=5.84.0","Tools(CBMC analysis)"
- "CPPcheck",">=2.13.4","Tools(CPPcheck)"
+ "Cppcheck",">=2.13.4","Tools(Cppcheck)"
.. _getting_started_toolchain:
@@ -159,7 +161,7 @@
On Ubuntu, ``gcovr`` tool can be installed in two different ways:
-Using the pagckage manager:
+Using the package manager:
.. code-block:: bash
@@ -209,6 +211,9 @@
You can read more about Git hooks in the *githooks* page of the `Git hooks
documentation`_.
+General contribution guidelines for contributors can be found in
+:ref:`Contributor's Guide`.
+
#################################
Install Cppcheck and dependencies
#################################
@@ -218,7 +223,7 @@
The installation of Cppcheck is an optional step. This is required only
if using the Cppcheck static analysis.
-The recommended version of Cppcheck is indicated :ref:`above<tool_dependencies>`.
+The recommended version of Cppcheck is indicated in :ref:`tool_dependencies`.
See :ref:`Cppcheck Application Note` for installation steps and details
on how to use it within RMM build system.
@@ -235,6 +240,23 @@
website https://www.cprover.org/cbmc/ or from the official github
https://github.com/diffblue/cbmc
+Refer to :ref:`CBMC` Application Notes for details on installation and
+running CBMC analysis on TF-RMM sources.
+
+##################
+Install Clang-tidy
+##################
+
+Clang-tidy is included in LLVM release package. It can also be installed via
+package manager :
+
+.. code-block:: bash
+
+ sudo apt-get install clang-tidy
+
+Note that the ``RMM_TOOLCHAIN`` needs to be set to `llvm` to run clang-tidy
+build targets from RMM build system.
+
###########################
Performing an Initial Build
###########################