From 4194c8d4bbd5bc48c2f50a7377c616f147385016 Mon Sep 17 00:00:00 2001 From: skal Date: Wed, 4 Feb 2026 10:22:15 +0100 Subject: feat(tooling): Implement code coverage reporting (Task #44) Added CMake support for coverage builds and a script to generate HTML reports using lcov on macOS. Also cleaned up .gitignore. --- doc/HOWTO.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'doc/HOWTO.md') diff --git a/doc/HOWTO.md b/doc/HOWTO.md index d402453..29492d5 100644 --- a/doc/HOWTO.md +++ b/doc/HOWTO.md @@ -117,6 +117,21 @@ ctest cd .. ``` +### Code Coverage (macOS only) + +To generate an HTML code coverage report for the project: + +1. **Install lcov:** + ```bash + brew install lcov + ``` + +2. **Run the coverage script:** + ```bash + ./scripts/gen_coverage_report.sh + ``` + This script will configure the build with `-DDEMO_ENABLE_COVERAGE=ON`, run the tests, and generate a report in `build_coverage/coverage_report/`. It will then attempt to open the report in your browser. + ## Tools ### Updating Submodules -- cgit v1.2.3