summaryrefslogtreecommitdiff
path: root/doc/HOWTO.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/HOWTO.md')
-rw-r--r--doc/HOWTO.md12
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