From: Nick Mathewson <nickm@torproject.org>
Date: Tue, 21 Jan 2014 21:44:48 +0000 (-0500)
Subject: Document more coverage tricks in doc/HACKING
X-Git-Tag: tor-0.2.5.2-alpha~42
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6a6bc9da531f3a4321bc421e76fd153efa69f2c0;p=thirdparty%2Ftor.git

Document more coverage tricks in doc/HACKING
---

diff --git a/doc/HACKING b/doc/HACKING
index a0072ec531..39eafec204 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -120,7 +120,7 @@ Running gcov for unit test coverage
 -----
    ./configure --enable-coverage
    make
-   ./src/test/test
+   make check
    mkdir coverage-output
    ./contrib/coverage coverage-output
 -----
@@ -135,6 +135,20 @@ If that doesn't work:
    * Try configuring Tor with --disable-gcc-hardening
    * You might need to run 'make clean' after you run './configure'.
 
+If you make changes to Tor and want to get another set of coverage results,
+you can run "make reset-gcov" to clear the intermediary gcov output.
+
+If you have two different "coverage-output" directories, and you want to see
+a meaningful diff between them, you can run:
+
+-----
+   ./contrib/cov-diff coverage-output1 coverage-output2 | less
+-----
+
+In this diff, any lines that were visited at least once will have coverage
+"1".  This lets you inspect what you (probably) really want to know: which
+untested lines were changed?  Are there any new untested lines?
+
 Running integration tests
 ~~~~~~~~~~~~~~~~~~~~~~~~~