From 5bbbce30ebff710dbb79b59fe38db10bd5f4b4fd Mon Sep 17 00:00:00 2001 From: Jonas Schnelli Date: Tue, 14 Nov 2017 21:28:36 -1000 Subject: [PATCH] Merge #11680: [docs] Add instructions for lcov report generation 5ff01c236 [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 --- doc/developer-notes.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 3bbd3f5ae8..1fb59f494f 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -183,6 +183,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 -------------------------