diff options
| author | James O'Beirne <james.obeirne@gmail.com> | 2017-11-13 23:06:48 -0800 |
|---|---|---|
| committer | James O'Beirne <james.obeirne@gmail.com> | 2017-11-14 15:29:45 -0800 |
| commit | 5ff01c236384c25ece31eba69f3718444cc2c599 (patch) | |
| tree | c5b9a941ff86a93b3411d5df8e6b13dc12d7a8b3 | |
| parent | 5e468994fbb349e8eefc996954a31a67a34aaa15 (diff) | |
[docs] Add instructions for lcov coverage report generation
| -rw-r--r-- | doc/developer-notes.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 763ab054ca..1904400c55 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -182,6 +182,22 @@ $ valgrind --suppressions=contrib/valgrind.supp --leak-check=full \ $ valgrind -v --leak-check=full src/bitcoind -printtoconsole ``` +**compiling for test coverage** + +LCOV can be used to generate a test coverage report based upon `make check` +execution. LCOV must be installed on your system (e.g. the `lcov` package +on Debian/Ubuntu). + +To enable LCOV report generation during test runs: + +```shell +./configure --enable-lcov +make +make cov + +# A coverage report will now be accessible at `./test_bitcoin.coverage/index.html`. +``` + Locking/mutex usage notes ------------------------- |