[tor-commits] [tor/master] Add stanza on lcov coverage target

[nickm at torproject.org]

commit eed942aed9175971b510f0f720274171f1895d01
Author: Kevin Murray <spam at kdmurray.id.au>
Date:   Wed Jul 9 18:55:44 2014 +1000

    Add stanza on lcov coverage target
    
    Adds a note about using `make coverage-html` to generate coverage
    reports.
    
    Signed-off-by: Kevin Murray <spam at kdmurray.id.au>
---
 doc/HACKING |   20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/doc/HACKING b/doc/HACKING
index 2562f7e..6b21426 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -114,6 +114,26 @@ valgrind --leak-check=yes --error-limit=no --show-reachable=yes src/or/tor
 pass --undef-value-errors=no to valgrind, or rebuild your openssl
 with -DPURIFY.)
 
+Running lcov for unit test coverage
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Lcov is a utility that generates pretty HTML reports of test code coverage.
+To generate such a report:
+
+-----
+   ./configure --enable-coverage
+   make
+   make coverage-html
+   $BROWSER ./coverage_html/index.html
+-----
+
+This will run the tor unit test suite `./src/test/test` and generate the HTML
+coverage code report under the directory ./coverage_html/. To change the
+output directory, use `make coverage-html HTML_COVER_DIR=./funky_new_cov_dir`.
+
+Coverage diffs using lcov are not currently implemented, but are being
+investigated (as of July 2014).
+
 Running gcov for unit test coverage
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~