nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-24 04:13:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add stanza on lcov coverage target

Browse Source 
Adds a note about using `make coverage-html` to generate coverage
reports.

Signed-off-by: Kevin Murray <spam@kdmurray.id.au>
This commit is contained in:
Kevin Murray 2014-07-09 18:55:44 +10:00 committed by Nick Mathewson
parent 8fa845548b
commit eed942aed9
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/HACKING
View File

@ -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 pass --undef-value-errors=no to valgrind, or rebuild your openssl
with -DPURIFY.) 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 Running gcov for unit test coverage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~