Skip to content

Commit 4db82b7

Browse files
committed
Merge #11680: [docs] Add instructions for lcov report generation
5ff01c2 [docs] Add instructions for lcov coverage report generation (James O'Beirne) Pull request description: After rediscovering the `lcov` report generation recipe one too many times, it seemed prudent to write some doc. Tree-SHA512: 20e1b5f51ecd39e14bd67986a2c1578fb7da03a50625366eaca35b201db66aef99cd4a5456df3aaca5d2d66b18ed7d2e8eb8f3bd9c7aaf9af48164d9bac38931
2 parents 3bdf242 + 5ff01c2 commit 4db82b7

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)