feat(tests): Add support for coverage report
This patch enables support for coverage report on the
unit tests by using the gcovr tool.
The coverage report is stored in ${RMM_BUILD_DIR}/$<CONFIG>/coverage
Signed-off-by: Javier Almansa Sobrino <javier.almansasobrino@arm.com>
Change-Id: I5b6a2f3ebf13cbc036c0d64f422ea18f337dd8f5
diff --git a/docs/getting_started/getting-started.rst b/docs/getting_started/getting-started.rst
index 4e8e07b..88747c9 100644
--- a/docs/getting_started/getting-started.rst
+++ b/docs/getting_started/getting-started.rst
@@ -49,6 +49,7 @@
"Git",, "Firmware, Documentation"
"Graphviz dot",">v2.38.0","Documentation"
"docutils",">v2.38.0","Documentation"
+ "gcovr",">=v4.2","Tools(Coverage analysis)"
.. _getting_started_toolchain:
@@ -143,6 +144,30 @@
cd <rmm source folder>
pip3 install -r docs/requirements.txt
+############################################
+Install coverage tools analysis dependencies
+############################################
+
+.. note::
+
+ This is an optional step only needed if you intend to run coverage
+ analysis on the source code.
+
+On Ubuntu, ``gcovr`` tool can be installed in two different ways:
+
+Using the pagckage manager:
+
+.. code-block:: bash
+
+ sudo apt-get install gcovr
+
+The second (and recommended) way is install it with ``pip3``:
+
+.. code-block:: bash
+
+ pip3 install --upgrade pip
+ pip3 install gcovr
+
.. _getting_started_get_source:
#########################