[docs] Add instructions for lcov coverage report generation

PastaPastaPasta · Nov 14, 2017 · 5ff01c2 · 5ff01c2
1 parent 5e46899
commit 5ff01c2
Showing 1 changed file with 16 additions and 0 deletions.
diff --git 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
 -------------------------