[Pcre-svn] [556] code/trunk/doc/pcre2_set_max_pattern_length…

Top Page
Delete this message
Author: Subversion repository
Date:  
To: pcre-svn
Subject: [Pcre-svn] [556] code/trunk/doc/pcre2_set_max_pattern_length.3: Documentation clarification
Revision: 556
          http://www.exim.org/viewvc/pcre2?view=rev&revision=556
Author:   ph10
Date:     2016-10-05 17:06:10 +0100 (Wed, 05 Oct 2016)
Log Message:
-----------
Documentation clarification


Modified Paths:
--------------
    code/trunk/doc/pcre2_set_max_pattern_length.3


Modified: code/trunk/doc/pcre2_set_max_pattern_length.3
===================================================================
--- code/trunk/doc/pcre2_set_max_pattern_length.3    2016-10-02 16:01:01 UTC (rev 555)
+++ code/trunk/doc/pcre2_set_max_pattern_length.3    2016-10-05 16:06:10 UTC (rev 556)
@@ -1,4 +1,4 @@
-.TH PCRE2_SET_MAX_PATTERN_LENGTH 3 "05 November 2015" "PCRE2 10.21"
+.TH PCRE2_SET_MAX_PATTERN_LENGTH 3 "05 October 2016" "PCRE2 10.23"
 .SH NAME
 PCRE2 - Perl-compatible regular expressions (revised API)
 .SH SYNOPSIS
@@ -14,8 +14,11 @@
 .SH DESCRIPTION
 .rs
 .sp
-This function sets, in a compile context, the maximum length (in code units) of
-the pattern that can be compiled. The result is always zero.
+This function sets, in a compile context, the maximum text length (in code
+units) of the pattern that can be compiled. The result is always zero. If a
+longer pattern is passed to \fBpcre2_compile()\fP there is an immediate error
+return. The default is effectively unlimited, being the largest value a
+PCRE2_SIZE variable can hold.
 .P
 There is a complete description of the PCRE2 native API in the
 .\" HREF