From 0c929b63adab9385486ac6e014f744d3d20e9e0a Mon Sep 17 00:00:00 2001 From: "Philip.Hazel" Date: Fri, 31 Mar 2017 17:06:43 +0000 Subject: [PATCH] Documentation update. --- doc/pcre2build.3 | 6 +++--- doc/pcre2grep.1 | 16 ++++++++-------- doc/pcre2jit.3 | 11 ++++------- doc/pcre2syntax.3 | 18 +++++++++--------- 4 files changed, 24 insertions(+), 27 deletions(-) diff --git a/doc/pcre2build.3 b/doc/pcre2build.3 index 9e9a10b..8c93d98 100644 --- a/doc/pcre2build.3 +++ b/doc/pcre2build.3 @@ -1,4 +1,4 @@ -.TH PCRE2BUILD 3 "29 March 2017" "PCRE2 10.30" +.TH PCRE2BUILD 3 "31 March 2017" "PCRE2 10.30" .SH NAME PCRE2 - Perl-compatible regular expressions (revised API) . @@ -270,7 +270,7 @@ limit controls this; it defaults to the value that is set for to the \fBconfigure\fP command. This value can also be overridden at run time. As well as applying to \fBpcre2_match()\fP, this limit also controls the depth of recursive function calls in \fBpcre2_dfa_match()\fP. These are used for -lookaround assertions and recursion within patterns. +lookaround assertions, atomic groups, and recursion within patterns. . . .SH "CREATING CHARACTER TABLES AT BUILD TIME" @@ -547,6 +547,6 @@ Cambridge, England. .rs .sp .nf -Last updated: 29 March 2017 +Last updated: 31 March 2017 Copyright (c) 1997-2017 University of Cambridge. .fi diff --git a/doc/pcre2grep.1 b/doc/pcre2grep.1 index b2d248b..a18bffe 100644 --- a/doc/pcre2grep.1 +++ b/doc/pcre2grep.1 @@ -1,4 +1,4 @@ -.TH PCRE2GREP 1 "21 March 2017" "PCRE2 10.30" +.TH PCRE2GREP 1 "31 March 2017" "PCRE2 10.30" .SH NAME pcre2grep - a grep with Perl-compatible regular expressions. .SH SYNOPSIS @@ -644,12 +644,12 @@ relying on the C I/O library to convert this to an appropriate sequence. Many of the short and long forms of \fBpcre2grep\fP's options are the same as in the GNU \fBgrep\fP program. Any long option of the form \fB--xxx-regexp\fP (GNU terminology) is also available as \fB--xxx-regex\fP -(PCRE2 terminology). However, the \fB--file-list\fP, \fB--file-offsets\fP, -\fB--include-dir\fP, \fB--line-offsets\fP, \fB--locale\fP, \fB--match-limit\fP, -\fB-M\fP, \fB--multiline\fP, \fB-N\fP, \fB--newline\fP, \fB--om-separator\fP, -\fB--recursion-limit\fP, \fB-u\fP, and \fB--utf-8\fP options are specific to -\fBpcre2grep\fP, as is the use of the \fB--only-matching\fP option with a -capturing parentheses number. +(PCRE2 terminology). However, the \fB--depth-limit\fP, \fB--file-list\fP, +\fB--file-offsets\fP, \fB--include-dir\fP, \fB--line-offsets\fP, +\fB--locale\fP, \fB--match-limit\fP, \fB-M\fP, \fB--multiline\fP, \fB-N\fP, +\fB--newline\fP, \fB--om-separator\fP, \fB-u\fP, and \fB--utf-8\fP options are +specific to \fBpcre2grep\fP, as is the use of the \fB--only-matching\fP option +with a capturing parentheses number. .P Although most of the common options work the same way, a few are different in \fBpcre2grep\fP. For example, the \fB--include\fP option's argument is a glob @@ -789,6 +789,6 @@ Cambridge, England. .rs .sp .nf -Last updated: 21 March 2017 +Last updated: 31 March 2017 Copyright (c) 1997-2017 University of Cambridge. .fi diff --git a/doc/pcre2jit.3 b/doc/pcre2jit.3 index eba9b8e..f6d17ca 100644 --- a/doc/pcre2jit.3 +++ b/doc/pcre2jit.3 @@ -1,4 +1,4 @@ -.TH PCRE2JIT 3 "30 March 2017" "PCRE2 10.30" +.TH PCRE2JIT 3 "31 March 2017" "PCRE2 10.30" .SH NAME PCRE2 - Perl-compatible regular expressions (revised API) .SH "PCRE2 JUST-IN-TIME COMPILER SUPPORT" @@ -178,11 +178,8 @@ allocation functions, or NULL for standard memory allocation). It returns a pointer to an opaque structure of type \fBpcre2_jit_stack\fP, or NULL if there is an error. The \fBpcre2_jit_stack_free()\fP function is used to free a stack that is no longer needed. (For the technically minded: the address space is -allocated by mmap or VirtualAlloc.) -.P -JIT uses far less memory for recursion than the interpretive code, -and a maximum stack size of 512K to 1M should be more than enough for any -pattern. +allocated by mmap or VirtualAlloc.) A maximum stack size of 512K to 1M should +be more than enough for any pattern. .P The \fBpcre2_jit_stack_assign()\fP function specifies which stack JIT code should use. Its arguments are as follows: @@ -413,6 +410,6 @@ Cambridge, England. .rs .sp .nf -Last updated: 30 March 2017 +Last updated: 31 March 2017 Copyright (c) 1997-2017 University of Cambridge. .fi diff --git a/doc/pcre2syntax.3 b/doc/pcre2syntax.3 index 29a9562..05b129c 100644 --- a/doc/pcre2syntax.3 +++ b/doc/pcre2syntax.3 @@ -1,4 +1,4 @@ -.TH PCRE2SYNTAX 3 "23 December 2016" "PCRE2 10.23" +.TH PCRE2SYNTAX 3 "31 March 2017" "PCRE2 10.30" .SH NAME PCRE2 - Perl-compatible regular expressions (revised API) .SH "PCRE2 REGULAR EXPRESSION SYNTAX SUMMARY" @@ -417,7 +417,7 @@ of the newline or \eR options with similar syntax. More than one of them may appear. .sp (*LIMIT_MATCH=d) set the match limit to d (decimal number) - (*LIMIT_RECURSION=d) set the recursion limit to d (decimal number) + (*LIMIT_DEPTH=d) set the backtracking limit to d (decimal number) (*NOTEMPTY) set PCRE2_NOTEMPTY when matching (*NOTEMPTY_ATSTART) set PCRE2_NOTEMPTY_ATSTART when matching (*NO_AUTO_POSSESS) no auto-possessification (PCRE2_NO_AUTO_POSSESS) @@ -427,11 +427,11 @@ appear. (*UTF) set appropriate UTF mode for the library in use (*UCP) set PCRE2_UCP (use Unicode properties for \ed etc) .sp -Note that LIMIT_MATCH and LIMIT_RECURSION can only reduce the value of the -limits set by the caller of \fBpcre2_match()\fP or \fBpcre2_dfa_match()\fP, not -increase them. The application can lock out the use of (*UTF) and (*UCP) by -setting the PCRE2_NEVER_UTF or PCRE2_NEVER_UCP options, respectively, at -compile time. +Note that LIMIT_MATCH and LIMIT_DEPTH can only reduce the value of the limits +set by the caller of \fBpcre2_match()\fP or \fBpcre2_dfa_match()\fP, not +increase them. LIMIT_RECURSION is an obsolete synonym for LIMIT_DEPTH. The +application can lock out the use of (*UTF) and (*UCP) by setting the +PCRE2_NEVER_UTF or PCRE2_NEVER_UCP options, respectively, at compile time. . . .SH "NEWLINE CONVENTION" @@ -585,6 +585,6 @@ Cambridge, England. .rs .sp .nf -Last updated: 23 December 2016 -Copyright (c) 1997-2016 University of Cambridge. +Last updated: 31 March 2017 +Copyright (c) 1997-2017 University of Cambridge. .fi