[tor-commits] [tor/master] Update coverage instructions

[nickm at torproject.org]

commit ad49ceba1f56109799adb9232ca0422067d1743d
Author: Nick Mathewson <nickm at torproject.org>
Date:   Tue Aug 6 12:00:16 2013 -0400

    Update coverage instructions
---
 doc/HACKING |   24 ++++++++++--------------
 1 file changed, 10 insertions(+), 14 deletions(-)

diff --git a/doc/HACKING b/doc/HACKING
index b7cd895..c94f69e 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -118,25 +118,21 @@ Running gcov for unit test coverage
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 -----
-  make clean
-  make CFLAGS='-g -fprofile-arcs -ftest-coverage'
-  ./src/test/test
-  gcov -o src/common src/common/*.[ch]
-  gcov -o src/or src/or/*.[ch]
-  cd ../or; gcov *.[ch]
+   ./configure --enable-coverage
+   make
+   ./src/test/test
+   mkdir coverage-output
+   ./contrib/coverage coverage-output
 -----
 
-Then, look at the .gcov files.  '-' before a line means that the
-compiler generated  no code for that line.  '######' means that the
-line was never reached.  Lines with numbers were called that number
-of times.
+(On OSX, you'll need to start with "--enable-coverage CC=clang".)
+
+Then, look at the .gcov files in coverage-output.  '-' before a line means
+that the compiler generated no code for that line.  '######' means that the
+line was never reached.  Lines with numbers were called that number of times.
 
 If that doesn't work:
    * Try configuring Tor with --disable-gcc-hardening
-   * On recent OSX versions, you might need to add CC=clang to your
-     build line, as in:
-        make CFLAGS='-g -fprofile-arcs -ftest-coverage' CC=clang
-     Their llvm-gcc doesn't work so great for me.
 
 Profiling Tor with oprofile
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~