Skip to content

Commit acb7f97

Browse files
committed
README: add a section for test coverage
It is a hassle to figure out the exact commands to create a good report.
1 parent 227a4f2 commit acb7f97

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,27 @@ With valgrind, you might need to increase the max stack size:
7777

7878
$ valgrind --max-stackframe=2500000 ./exhaustive_tests
7979

80+
Test coverage
81+
-----------
82+
83+
This library aims to have full coverage of the reachable lines and branches.
84+
85+
To create a test coverage report, configure with `--enable-coverage` (use of GCC is necessary):
86+
87+
$ ./configure --enable-coverage
88+
89+
Run the tests:
90+
91+
$ make check
92+
93+
To create a report, `gcovr` is recommended, as it includes branch coverage reporting:
94+
95+
$ gcovr --exclude 'src/bench*' --print-summary
96+
97+
To create a HTML report with coloured and annotated source code:
98+
99+
$ gcovr --exclude 'src/bench*' --html --html-details -o coverage.html
100+
80101
Reporting a vulnerability
81102
------------
82103

0 commit comments

Comments
 (0)