r17433@tombo: nickm | 2008-07-29 10:58:07 -0400

 Docment gcov in HACKING

svn:r16254

diff --git a/doc/HACKING b/doc/HACKING
index 3b914722a5b849ce44017d5f66eaaca8664b08f8..13ea0bac676212090aa129238efb8b308d701447 100644 (file)
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -2,7 +2,7 @@
 0. The buildbot.
 
   http://tor-buildbot.freehaven.net:8010/
-  
+
   - Down for unknown reasons, ioerror will look into this.
 
 0.1. Useful command-lines that are non-trivial to reproduce but can
@@ -14,6 +14,19 @@ dmalloc -l ~/dmalloc.log
 
 valgrind --leak-check=yes --error-limit=no --show-reachable=yes src/or/tor
 
+0.2. Running gcov for unit test coverage
+
+  make clean
+  make CFLAGS='-g -fprofile-arcs -ftest-coverage'
+  ./src/or/test
+  cd src/common; gcov *.[ch]
+  cd ../or; gcov *.[ch]
+
+  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.
+
 1. Coding conventions
 
 1.0. Whitespace and C conformance