From 5ff01c236384c25ece31eba69f3718444cc2c599 Mon Sep 17 00:00:00 2001 From: James O'Beirne Date: Mon, 13 Nov 2017 23:06:48 -0800 Subject: [PATCH] [docs] Add instructions for lcov coverage report generation --- doc/developer-notes.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 763ab054caea9..1904400c55d1b 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 -------------------------