diff options
| author | skal <pascal.massimino@gmail.com> | 2026-02-04 10:40:21 +0100 |
|---|---|---|
| committer | skal <pascal.massimino@gmail.com> | 2026-02-04 10:40:21 +0100 |
| commit | 3850a46d1d4138b80dbc20bbe4ac4342d6911ab0 (patch) | |
| tree | 017c62612b034065c35aa3b350e41da00d3bb30b /doc | |
| parent | 8da917bce6e937ab092bb2f68c0bcf6039c3a3d7 (diff) | |
feat(tooling): Add directory filtering to coverage report script (Task #46)
Updated gen_coverage_report.sh to accept an optional argument for targeting specific directories using lcov --extract.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HOWTO.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/HOWTO.md b/doc/HOWTO.md index 29492d5..e562679 100644 --- a/doc/HOWTO.md +++ b/doc/HOWTO.md @@ -128,10 +128,20 @@ To generate an HTML code coverage report for the project: 2. **Run the coverage script:** ```bash - ./scripts/gen_coverage_report.sh + ./scripts/gen_coverage_report.sh [optional_target_dir] ``` 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. + **Examples:** + * Full project report: + ```bash + ./scripts/gen_coverage_report.sh + ``` + * Report for `src/procedural` only: + ```bash + ./scripts/gen_coverage_report.sh src/procedural + ``` + ## Tools ### Updating Submodules |