Added test-coverage/README file
authorMichael Rash <mbr@cipherdyne.org>
Wed, 13 Feb 2013 03:08:42 +0000 (22:08 -0500)
committerMichael Rash <mbr@cipherdyne.org>
Wed, 13 Feb 2013 03:08:42 +0000 (22:08 -0500)
test/test-coverage/README [new file with mode: 0644]

diff --git a/test/test-coverage/README b/test/test-coverage/README
new file mode 100644 (file)
index 0000000..9b389d2
--- /dev/null
@@ -0,0 +1,15 @@
+This directory is used to collect information on which functions in the fwknop
+sources are never called when the test suite is executed.  This assumes that
+fwknop has been compiled with test coverage support like this:
+
+$ CFLAGS="-O0 -fprofile-arcs -ftest-coverage" LDFLAGS="-fprofile-arcs" ./configure --prefix=/usr --sysconfdir=/etc
+$ make
+
+Or, just do:
+
+$ ./configure --enable-profile-coverage --prefix=/usr --sysconfdir=/etc
+
+Then the test suite can be executed with the --enable-profile-coverage-check
+argument so that functions that are never called can be seen:
+
+# ./test-fwknop.pl --enable-profile-coverage-check