Revision: 1178
http://vcs.pcre.org/viewvc?view=rev&revision=1178
Author: ph10
Date: 2012-10-27 17:49:31 +0100 (Sat, 27 Oct 2012)
Log Message:
-----------
Documentation edits for coverage.
Modified Paths:
--------------
code/trunk/README
code/trunk/doc/pcrebuild.3
Modified: code/trunk/README
===================================================================
--- code/trunk/README 2012-10-27 16:07:40 UTC (rev 1177)
+++ code/trunk/README 2012-10-27 16:49:31 UTC (rev 1178)
@@ -186,7 +186,7 @@
. By default, only the 8-bit library is built. If you add --enable-pcre16 to
the "configure" command, the 16-bit library is also built. If you add
--enable-pcre32 to the "configure" command, the 32-bit library is also built.
- If you want only the 16-bit or 32-bit library, --disable-pcre8 to disable
+ If you want only the 16-bit or 32-bit library, use --disable-pcre8 to disable
building the 8-bit library.
. If you are building the 8-bit library and want to suppress the building of
@@ -324,7 +324,26 @@
both EBCDIC and UTF-8/16/32. There is a second option, --enable-ebcdic-nl25,
which specifies that the code value for the EBCDIC NL character is 0x25
instead of the default 0x15.
+
+. In environments where valgrind is installed, if you specify
+ --enable-valgrind
+
+ PCRE will use valgrind annotations to mark certain memory regions as
+ unaddressable. This allows it to detect invalid memory accesses, and is
+ mostly useful for debugging PCRE itself.
+
+. In environments where the gcc compiler is used and lcov version 1.6 or above
+ is installed, if you specify
+
+ --enable-coverage
+
+ the build process implements a code coverage report for the test suite. The
+ report is generated by running "make coverage". If ccache is installed on
+ your system, it must be disabled when building PCRE for coverage reporting.
+ You can do this by setting the environment variable CCACHE_DISABLE=1 before
+ running "make" to build PCRE.
+
. The pcregrep program currently supports only 8-bit data files, and so
requires the 8-bit PCRE library. It is possible to compile pcregrep to use
libz and/or libbz2, in order to read .gz and .bz2 files (respectively), by
@@ -913,4 +932,4 @@
Philip Hazel
Email local part: ph10
Email domain: cam.ac.uk
-Last updated: 07 September 2012
+Last updated: 27 October 2012
Modified: code/trunk/doc/pcrebuild.3
===================================================================
--- code/trunk/doc/pcrebuild.3 2012-10-27 16:07:40 UTC (rev 1177)
+++ code/trunk/doc/pcrebuild.3 2012-10-27 16:49:31 UTC (rev 1178)
@@ -1,4 +1,4 @@
-.TH PCREBUILD 3 "08 September 2012" "PCRE 8.32"
+.TH PCREBUILD 3 "27 October 2012" "PCRE 8.32"
.SH NAME
PCRE - Perl-compatible regular expressions
.
@@ -433,8 +433,8 @@
--enable-valgrind
.sp
option to to the \fBconfigure\fP command, PCRE will use valgrind annotations
-to mark certain memory regions as unaddressable. This allows to detect invalid
-memory accesses, and is mostly useful for debugging PCRE itself.
+to mark certain memory regions as unaddressable. This allows it to detect
+invalid memory accesses, and is mostly useful for debugging PCRE itself.
.
.
.SH "CODE COVERAGE REPORTING"
@@ -449,12 +449,13 @@
.sp
make coverage
.sp
-Note that using \fBccache\fP is incompatible with code coverage reporting;
-you must set the environment variable
+Note that using \fBccache\fP (a caching C compiler) is incompatible with code
+coverage reporting. If you have configured \fBccache\fP to run automatically
+on your system you must set the environment variable
.sp
CCACHE_DISABLE=1
.sp
-before running make.
+before running make to build PCRE, so that \fBccache\fP is not used.
.
.
.SH "SEE ALSO"
@@ -477,6 +478,6 @@
.rs
.sp
.nf
-Last updated: 08 September 2012
+Last updated: 27 October 2012
Copyright (c) 1997-2012 University of Cambridge.
.fi
