[Pcre-svn] [938] code/trunk: Documentation update.

Top Page
Delete this message
Author: Subversion repository
Date:  
To: pcre-svn
Subject: [Pcre-svn] [938] code/trunk: Documentation update.
Revision: 938
          http://www.exim.org/viewvc/pcre2?view=rev&revision=938
Author:   ph10
Date:     2018-06-18 17:49:12 +0100 (Mon, 18 Jun 2018)
Log Message:
-----------
Documentation update.


Modified Paths:
--------------
    code/trunk/ChangeLog
    code/trunk/doc/pcre2api.3


Modified: code/trunk/ChangeLog
===================================================================
--- code/trunk/ChangeLog    2018-06-18 14:03:33 UTC (rev 937)
+++ code/trunk/ChangeLog    2018-06-18 16:49:12 UTC (rev 938)
@@ -370,7 +370,7 @@
 31. If more than one of "push", "pushcopy", or "pushtablescopy" were set in
 pcre2test, a crash could occur.


-32. Make -bigstack in RunTest allocate a 64MiB stack (instead of 16 MiB) so
+32. Make -bigstack in RunTest allocate a 64MiB stack (instead of 16MiB) so
that all the tests can run with clang's sanitizing options.

33. Implement extra compile options in the compile context and add the first

Modified: code/trunk/doc/pcre2api.3
===================================================================
--- code/trunk/doc/pcre2api.3    2018-06-18 14:03:33 UTC (rev 937)
+++ code/trunk/doc/pcre2api.3    2018-06-18 16:49:12 UTC (rev 938)
@@ -1,4 +1,4 @@
-.TH PCRE2API 3 "27 April 2018" "PCRE2 10.32"
+.TH PCRE2API 3 "18 June 2018" "PCRE2 10.32"
 .SH NAME
 PCRE2 - Perl-compatible regular expressions (revised API)
 .sp
@@ -917,9 +917,9 @@
 used. In this case, only patterns that do not have a lot of nested backtracking
 can be successfully processed.
 .P
-Similarly, for \fBpcre2_dfa_match()\fP, a vector on the system stack is used 
-when processing pattern recursions, lookarounds, or atomic groups, and only if 
-this is not big enough is heap memory used. In this case, too, setting a value 
+Similarly, for \fBpcre2_dfa_match()\fP, a vector on the system stack is used
+when processing pattern recursions, lookarounds, or atomic groups, and only if
+this is not big enough is heap memory used. In this case, too, setting a value
 of zero disables the use of the heap.
 .sp
 .nf
@@ -990,7 +990,7 @@
 probably better to limit heap usage directly by calling
 \fBpcre2_set_heap_limit()\fP.
 .P
-The default value for the depth limit can be set when PCRE2 is built; if it is 
+The default value for the depth limit can be set when PCRE2 is built; if it is
 not, the default is set to the same value as the default for the match limit.
 If the limit is exceeded, \fBpcre2_match()\fP or \fBpcre2_dfa_match()\fP
 returns PCRE2_ERROR_DEPTHLIMIT. A value for the depth limit may also be
@@ -1052,7 +1052,7 @@
   PCRE2_CONFIG_HEAPLIMIT
 .sp
 The output is a uint32_t integer that gives, in kibibytes, the default limit
-for the amount of heap memory used by \fBpcre2_match()\fP or 
+for the amount of heap memory used by \fBpcre2_match()\fP or
 \fBpcre2_dfa_match()\fP. Further details are given with
 \fBpcre2_set_heap_limit()\fP above.
 .sp
@@ -2552,7 +2552,7 @@
 calls to \fBpcre2_match()\fP if you are making repeated calls to find other
 matches in the same subject string.
 .P
-WARNING: When PCRE2_NO_UTF_CHECK is set, the effect of passing an invalid
+\fBWarning:\fP When PCRE2_NO_UTF_CHECK is set, the effect of passing an invalid
 string as a subject, or an invalid value of \fIstartoffset\fP, is undefined.
 Your program may crash or loop indefinitely.
 .sp
@@ -2769,6 +2769,14 @@
 branch of the group, but it is not on the matching path. On the other hand,
 when this pattern fails to match "bx", the returned name is B.
 .P
+\fBWarning:\fP By default, certain start-of-match optimizations are used to
+give a fast "no match" result in some situations. For example, if the anchoring
+is removed from the pattern above, there is an initial check for the presence
+of "c" in the subject before running the matching engine. This check fails for
+"bx", causing a match failure without seeing any marks. You can disable the
+start-of-match optimizations by setting the PCRE2_NO_START_OPTIMIZE option for
+\fBpcre2_compile()\fP or starting the pattern with (*NO_START_OPT).
+.P
 After a successful match, a partial match, or one of the invalid UTF errors
 (for example, PCRE2_ERROR_UTF8_ERR5), \fBpcre2_get_startchar()\fP can be
 called. After a successful or partial match it returns the code unit offset of
@@ -3613,6 +3621,6 @@
 .rs
 .sp
 .nf
-Last updated: 27 April 2018
+Last updated: 18 June 2018
 Copyright (c) 1997-2018 University of Cambridge.
 .fi