Revision: 710
http://www.exim.org/viewvc/pcre2?view=rev&revision=710
Author: ph10
Date: 2017-03-26 16:44:09 +0100 (Sun, 26 Mar 2017)
Log Message:
-----------
Documentation update.
Modified Paths:
--------------
code/trunk/doc/html/pcre2_substitute.html
code/trunk/doc/pcre2_substitute.3
Modified: code/trunk/doc/html/pcre2_substitute.html
===================================================================
--- code/trunk/doc/html/pcre2_substitute.html 2017-03-25 17:50:54 UTC (rev 709)
+++ code/trunk/doc/html/pcre2_substitute.html 2017-03-26 15:44:09 UTC (rev 710)
@@ -47,26 +47,29 @@
<i>outputbuffer</i> Points to the output buffer
<i>outlengthptr</i> Points to the length of the output buffer
</pre>
-A match context is needed only if you want to:
+A match data block is needed only if you want to inspect the data from the
+match that is returned in that block. A match context is needed only if you
+want to:
<pre>
Set up a callout function
- Change the limit for calling the internal function <i>match()</i>
- Change the limit for calling <i>match()</i> recursively
- Set custom memory management when the heap is used for recursion
+ Set a matching offset limit
+ Change the backtracking match limit
+ Change the backtracking depth limit
+ Set custom memory management in the match context
</pre>
The <i>length</i>, <i>startoffset</i> and <i>rlength</i> values are code
units, not characters, as is the contents of the variable pointed at by
<i>outlengthptr</i>, which is updated to the actual length of the new string.
-The options are:
+The subject and replacement lengths can be given as PCRE2_ZERO_TERMINATED for
+zero-terminated strings. The options are:
<pre>
PCRE2_ANCHORED Match only at the first position
PCRE2_NOTBOL Subject is not the beginning of a line
PCRE2_NOTEOL Subject is not the end of a line
PCRE2_NOTEMPTY An empty string is not a valid match
- PCRE2_NOTEMPTY_ATSTART An empty string at the start of the
- subject is not a valid match
- PCRE2_NO_UTF_CHECK Do not check the subject or replacement
- for UTF validity (only relevant if
+ PCRE2_NOTEMPTY_ATSTART An empty string at the start of the subject is not a valid match
+ PCRE2_NO_JIT Do not use JIT matching
+ PCRE2_NO_UTF_CHECK Do not check the subject or replacement for UTF validity (only relevant if
PCRE2_UTF was set at compile time)
PCRE2_SUBSTITUTE_EXTENDED Do extended replacement processing
PCRE2_SUBSTITUTE_GLOBAL Replace all occurrences in the subject
Modified: code/trunk/doc/pcre2_substitute.3
===================================================================
--- code/trunk/doc/pcre2_substitute.3 2017-03-25 17:50:54 UTC (rev 709)
+++ code/trunk/doc/pcre2_substitute.3 2017-03-26 15:44:09 UTC (rev 710)
@@ -1,4 +1,4 @@
-.TH PCRE2_SUBSTITUTE 3 "12 December 2015" "PCRE2 10.21"
+.TH PCRE2_SUBSTITUTE 3 "26 March 2017" "PCRE2 10.30"
.SH NAME
PCRE2 - Perl-compatible regular expressions (revised API)
.SH SYNOPSIS
@@ -35,24 +35,31 @@
\fIoutputbuffer\fP Points to the output buffer
\fIoutlengthptr\fP Points to the length of the output buffer
.sp
-A match context is needed only if you want to:
+A match data block is needed only if you want to inspect the data from the
+match that is returned in that block. A match context is needed only if you
+want to:
.sp
Set up a callout function
- Change the limit for calling the internal function \fImatch()\fP
- Change the limit for calling \fImatch()\fP recursively
- Set custom memory management when the heap is used for recursion
+ Set a matching offset limit
+ Change the backtracking match limit
+ Change the backtracking depth limit
+ Set custom memory management in the match context
.sp
The \fIlength\fP, \fIstartoffset\fP and \fIrlength\fP values are code
units, not characters, as is the contents of the variable pointed at by
\fIoutlengthptr\fP, which is updated to the actual length of the new string.
-The options are:
+The subject and replacement lengths can be given as PCRE2_ZERO_TERMINATED for
+zero-terminated strings. The options are:
.sp
PCRE2_ANCHORED Match only at the first position
PCRE2_NOTBOL Subject is not the beginning of a line
PCRE2_NOTEOL Subject is not the end of a line
PCRE2_NOTEMPTY An empty string is not a valid match
+.\" JOIN
PCRE2_NOTEMPTY_ATSTART An empty string at the start of the
subject is not a valid match
+ PCRE2_NO_JIT Do not use JIT matching
+.\" JOIN
PCRE2_NO_UTF_CHECK Do not check the subject or replacement
for UTF validity (only relevant if
PCRE2_UTF was set at compile time)
