From eed942aed9175971b510f0f720274171f1895d01 Mon Sep 17 00:00:00 2001 From: Kevin Murray Date: Wed, 9 Jul 2014 18:55:44 +1000 Subject: Add stanza on lcov coverage target Adds a note about using `make coverage-html` to generate coverage reports. Signed-off-by: Kevin Murray --- doc/HACKING | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'doc/HACKING') diff --git a/doc/HACKING b/doc/HACKING index 2562f7e2e9..6b21426497 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3-54-g00ecf