summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15>2012-10-27 16:49:31 +0000
committerph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15>2012-10-27 16:49:31 +0000
commite45619991093e38cd2d1f157ef44f084ece70dd4 (patch)
treedc5cb6009e554fbfb83076c6b2bb679f0822bfb4 /README
parent0c888c5ada852f8e185190524c691c5a45885b50 (diff)
downloadpcre-e45619991093e38cd2d1f157ef44f084ece70dd4.tar.gz
Documentation edits for coverage.
git-svn-id: svn://vcs.exim.org/pcre/code/trunk@1178 2f5784b3-3f2a-0410-8824-cb99058d5e15
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 22 insertions, 3 deletions
diff --git a/README b/README
index a65cf9e..1914e47 100644
--- a/README
+++ b/README
@@ -186,7 +186,7 @@ library. They are also documented in the pcrebuild man page.
. 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 @@ library. They are also documented in the pcrebuild man page.
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 @@ pcre_xxx, one with the name pcre16_xx, and a third with the name pcre32_xxx.
Philip Hazel
Email local part: ph10
Email domain: cam.ac.uk
-Last updated: 07 September 2012
+Last updated: 27 October 2012