summaryrefslogtreecommitdiff
path: root/doc/pcrebuild.3
diff options
context:
space:
mode:
authorchpe <chpe@2f5784b3-3f2a-0410-8824-cb99058d5e15>2012-10-22 19:43:50 +0000
committerchpe <chpe@2f5784b3-3f2a-0410-8824-cb99058d5e15>2012-10-22 19:43:50 +0000
commit70fa5f16716080d8e1dbf8df856e0b09d9fe96a9 (patch)
treef63ab5452549f306a3e5ae2a080bc772e37c01d4 /doc/pcrebuild.3
parent8dbb61be460ee8681a401017cbee5b5a92b62ea2 (diff)
downloadpcre-70fa5f16716080d8e1dbf8df856e0b09d9fe96a9.tar.gz
build: Add code coverage reporting
Add --enable-coverage which uses gcov/lcov to generate a code coverage report from the test suite. http://bugs.exim.org/show_bug.cgi?id=1266 git-svn-id: svn://vcs.exim.org/pcre/code/trunk@1158 2f5784b3-3f2a-0410-8824-cb99058d5e15
Diffstat (limited to 'doc/pcrebuild.3')
-rw-r--r--doc/pcrebuild.320
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/pcrebuild.3 b/doc/pcrebuild.3
index 04098f1..eb6cc78 100644
--- a/doc/pcrebuild.3
+++ b/doc/pcrebuild.3
@@ -437,6 +437,26 @@ to mark certain memory regions as unaddressable. This allows to detect invalid
memory accesses, and is mostly useful for debugging PCRE itself.
.
.
+.SH "CODE COVERAGE REPORTING"
+.rs
+.sp
+The build process can generate a code coverage report for the test suite.
+To enable this, you must install \fBlcov\fP version 1.6 or above. Then use
+.sp
+ --enable-coverage
+.sp
+to the \fBconfigure\fP command, and generate the report by running
+.sp
+ make coverage
+.sp
+Note that using \fBccache\fP is incompatible with code coverage reporting;
+you must set the environment variable
+.sp
+ CCACHE_DISABLE=1
+.sp
+before running make.
+.
+.
.SH "SEE ALSO"
.rs
.sp