summaryrefslogtreecommitdiff
path: root/README-gcov
diff options
context:
space:
mode:
authorBen Pfaff <blp@nicira.com>2009-07-27 16:42:51 -0700
committerBen Pfaff <blp@nicira.com>2009-07-29 12:33:32 -0700
commitc2b070214097fa40dc78252882d96babe7fab4b4 (patch)
treeba992f3264d556f3e376a1248d26fc800116590a /README-gcov
parent1b233b95b5907a242ee453cbea3ad4bc4cd4fec2 (diff)
downloadopenvswitch-c2b070214097fa40dc78252882d96babe7fab4b4.tar.gz
Add support for code coverage analysis with gcov and lcov.
Diffstat (limited to 'README-gcov')
-rw-r--r--README-gcov31
1 files changed, 31 insertions, 0 deletions
diff --git a/README-gcov b/README-gcov
new file mode 100644
index 000000000..665a1ec14
--- /dev/null
+++ b/README-gcov
@@ -0,0 +1,31 @@
+Building with gcov support
+==========================
+
+The Open vSwitch "configure" script supports the following
+code-coverage related options:
+
+ --disable-coverage
+ --enable-coverage=no
+
+ Do not build with gcov code coverage support.
+
+ This is the default if no coverage option is passed to
+ "configure".
+
+ --enable-coverage
+ --enable-coverage=yes
+
+ Build with gcov code coverage support, but do not assume that any
+ coverage-related tools are installed and do not add special
+ coverage support to the test suite.
+
+ --enable-coverage=lcov
+
+ Build with gcov code coverage support, as above, but also add
+ support for coverage analysis to the test suite. Running "make
+ check" will produce a directory "tests/coverage.html" in the build
+ directory with an analysis of the test suite's coverage.
+
+ This setting requires the lcov suite of utilities to be installed.
+ The "lcov" and "genhtml" programs from lcov must be in PATH. lcov
+ is available at: http://ltp.sourceforge.net/coverage/lcov.php