diff options
| author | skal <pascal.massimino@gmail.com> | 2026-02-04 10:22:15 +0100 |
|---|---|---|
| committer | skal <pascal.massimino@gmail.com> | 2026-02-04 10:22:15 +0100 |
| commit | 4194c8d4bbd5bc48c2f50a7377c616f147385016 (patch) | |
| tree | 06b17897a068a45466cfa751a1a1d3449fc6ebf5 /doc/HOWTO.md | |
| parent | 24d39afe882c92da8a2dfb543b97008cf50d7ec1 (diff) | |
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.
Diffstat (limited to 'doc/HOWTO.md')
| -rw-r--r-- | doc/HOWTO.md | 15 |
1 files changed, 15 insertions, 0 deletions
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 |