Skip to content

Commit 5ff01c2

Browse files
committed
[docs] Add instructions for lcov coverage report generation
1 parent 5e46899 commit 5ff01c2

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

doc/developer-notes.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,22 @@ $ valgrind --suppressions=contrib/valgrind.supp --leak-check=full \
182182
$ valgrind -v --leak-check=full src/bitcoind -printtoconsole
183183
```
184184

185+
**compiling for test coverage**
186+
187+
LCOV can be used to generate a test coverage report based upon `make check`
188+
execution. LCOV must be installed on your system (e.g. the `lcov` package
189+
on Debian/Ubuntu).
190+
191+
To enable LCOV report generation during test runs:
192+
193+
```shell
194+
./configure --enable-lcov
195+
make
196+
make cov
197+
198+
# A coverage report will now be accessible at `./test_bitcoin.coverage/index.html`.
199+
```
200+
185201
Locking/mutex usage notes
186202
-------------------------
187203

0 commit comments

Comments
 (0)