Skip to content

Commit

Permalink
Doc file tidies for 10.38-RC1
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilipHazel committed Aug 31, 2021
1 parent e2fde18 commit 8f3e11a
Show file tree
Hide file tree
Showing 24 changed files with 97 additions and 95 deletions.
2 changes: 1 addition & 1 deletion README
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ repository:
https://github.com/PhilipHazel/pcre2/releases

There is a mailing list for discussion about the development of PCRE2 at
pcre2-dev@googlegroups.com. You can subscribe by sending an email to
pcre2-dev@googlegroups.com. You can subscribe by sending an email to
pcre2-dev+subscribe@googlegroups.com.

You can access the archives and also subscribe or manage your subscription
Expand Down
2 changes: 1 addition & 1 deletion doc/html/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ repository:
https://github.com/PhilipHazel/pcre2/releases

There is a mailing list for discussion about the development of PCRE2 at
pcre2-dev@googlegroups.com. You can subscribe by sending an email to
pcre2-dev@googlegroups.com. You can subscribe by sending an email to
pcre2-dev+subscribe@googlegroups.com.

You can access the archives and also subscribe or manage your subscription
Expand Down
2 changes: 1 addition & 1 deletion doc/html/pcre2.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h1>pcre2 man page</h1>
increasingly difficult. The new API is more extensible, and it was simplified
by abolishing the separate "study" optimizing function; in PCRE2, patterns are
automatically optimized where possible. Since forking from PCRE1, the code has
been extensively refactored and new features introduced. The old library is now
been extensively refactored and new features introduced. The old library is now
obsolete and is no longer maintained.
</P>
<P>
Expand Down
8 changes: 4 additions & 4 deletions doc/html/pcre2_dfa_match.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ <h1>pcre2_dfa_match man page</h1>
<i>workspace</i> Points to a vector of ints used as working space
<i>wscount</i> Number of elements in the vector
</pre>
The size of output vector needed to contain all the results depends on the
number of simultaneous matches, not on the number of parentheses in the
pattern. Using <b>pcre2_match_data_create_from_pattern()</b> to create the match
data block is therefore not advisable when using this function.
The size of output vector needed to contain all the results depends on the
number of simultaneous matches, not on the number of parentheses in the
pattern. Using <b>pcre2_match_data_create_from_pattern()</b> to create the match
data block is therefore not advisable when using this function.
</P>
<P>
A match context is needed only if you want to set up a callout function or
Expand Down
16 changes: 8 additions & 8 deletions doc/html/pcre2api.html
Original file line number Diff line number Diff line change
Expand Up @@ -1917,10 +1917,10 @@ <h1>pcre2api man page</h1>
<pre>
PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK
</pre>
Since release 10.38 PCRE2 has forbidden the use of \K within lookaround
assertions, following Perl's lead. This option is provided to re-enable the
previous behaviour (act in positive lookarounds, ignore in negative ones) in
case anybody is relying on it.
Since release 10.38 PCRE2 has forbidden the use of \K within lookaround
assertions, following Perl's lead. This option is provided to re-enable the
previous behaviour (act in positive lookarounds, ignore in negative ones) in
case anybody is relying on it.
<pre>
PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES
</pre>
Expand Down Expand Up @@ -2526,7 +2526,7 @@ <h1>pcre2api man page</h1>
Before calling <b>pcre2_match()</b>, <b>pcre2_dfa_match()</b>, or
<b>pcre2_jit_match()</b> you must create a match data block by calling one of
the creation functions above. For <b>pcre2_match_data_create()</b>, the first
argument is the number of pairs of offsets in the <i>ovector</i>.
argument is the number of pairs of offsets in the <i>ovector</i>.
</P>
<P>
When using <b>pcre2_match()</b>, one pair of offsets is required to identify the
Expand All @@ -2535,14 +2535,14 @@ <h1>pcre2api man page</h1>
the matched portion of the subject plus three captured substrings.
</P>
<P>
When using <b>pcre2_dfa_match()</b> there may be multiple matched substrings of
When using <b>pcre2_dfa_match()</b> there may be multiple matched substrings of
different lengths at the same point in the subject. The ovector should be made
large enough to hold as many as are expected.
</P>
<P>
A minimum of at least 1 pair is imposed by <b>pcre2_match_data_create()</b>, so
it is always possible to return the overall matched string in the case of
<b>pcre2_match()</b> or the longest match in the case of
it is always possible to return the overall matched string in the case of
<b>pcre2_match()</b> or the longest match in the case of
<b>pcre2_dfa_match()</b>.
</P>
<P>
Expand Down
6 changes: 3 additions & 3 deletions doc/html/pcre2demo.html
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,11 @@ <h1>pcre2demo man page</h1>
if (rc == 0)
printf("ovector was not big enough for all the captured substrings\n");

/* Since release 10.38 PCRE2 has locked out the use of \K in lookaround
assertions. However, there is an option to re-enable the old behaviour. If that
/* Since release 10.38 PCRE2 has locked out the use of \K in lookaround
assertions. However, there is an option to re-enable the old behaviour. If that
is set, it is possible to run patterns such as /(?=.\K)/ that use \K in an
assertion to set the start of a match later than its end. In this demonstration
program, we show how to detect this case, but it shouldn't arise because the
program, we show how to detect this case, but it shouldn't arise because the
option is never set. */

if (ovector[0] &gt; ovector[1])
Expand Down
8 changes: 4 additions & 4 deletions doc/html/pcre2pattern.html
Original file line number Diff line number Diff line change
Expand Up @@ -1175,10 +1175,10 @@ <h1>pcre2pattern man page</h1>
matches "foobar", the first substring is still set to "foo".
</P>
<P>
From version 5.32.0 Perl forbids the use of \K in lookaround assertions. From
release 10.38 PCRE2 also forbids this by default. However, the
PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK option can be used when calling
<b>pcre2_compile()</b> to re-enable the previous behaviour. When this option is
From version 5.32.0 Perl forbids the use of \K in lookaround assertions. From
release 10.38 PCRE2 also forbids this by default. However, the
PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK option can be used when calling
<b>pcre2_compile()</b> to re-enable the previous behaviour. When this option is
set, \K is acted upon when it occurs inside positive assertions, but is
ignored in negative assertions. Note that when a pattern such as (?=ab\K)
matches, the reported start of the match can be greater than the end of the
Expand Down
2 changes: 1 addition & 1 deletion doc/html/pcre2syntax.html
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ <h1>pcre2syntax man page</h1>
<pre>
\K set reported start of match
</pre>
From release 10.38 \K is not permitted by default in lookaround assertions,
From release 10.38 \K is not permitted by default in lookaround assertions,
for compatibility with Perl. However, if the PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK
option is set, the previous behaviour is re-enabled. When this option is set,
\K is honoured in positive assertions, but ignored in negative ones.
Expand Down
4 changes: 2 additions & 2 deletions doc/html/pcre2test.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h1>pcre2test man page</h1>
<br><a name="SEC3" href="#TOC1">INPUT ENCODING</a><br>
<P>
Input to <b>pcre2test</b> is processed line by line, either by calling the C
library's <b>fgets()</b> function, or via the <b>libreadline</b> or <b>libedit</b>
library's <b>fgets()</b> function, or via the <b>libreadline</b> or <b>libedit</b>
library. In some Windows environments character 26 (hex 1A) causes an immediate
end of file, and no further data is read, so this character should be avoided
unless you really want that action.
Expand Down Expand Up @@ -610,7 +610,7 @@ <h1>pcre2test man page</h1>
for a description of the effects of these options.
<pre>
allow_empty_class set PCRE2_ALLOW_EMPTY_CLASS
allow_lookaround_bsk set PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK
allow_lookaround_bsk set PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK
allow_surrogate_escapes set PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES
alt_bsux set PCRE2_ALT_BSUX
alt_circumflex set PCRE2_ALT_CIRCUMFLEX
Expand Down
2 changes: 1 addition & 1 deletion doc/pcre2.3
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ nearly two decades, the limitations of the original API were making development
increasingly difficult. The new API is more extensible, and it was simplified
by abolishing the separate "study" optimizing function; in PCRE2, patterns are
automatically optimized where possible. Since forking from PCRE1, the code has
been extensively refactored and new features introduced. The old library is now
been extensively refactored and new features introduced. The old library is now
obsolete and is no longer maintained.
.P
As well as Perl-style regular expression patterns, some features that appeared
Expand Down
60 changes: 30 additions & 30 deletions doc/pcre2.txt
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,8 @@ REVISION
Last updated: 27 August 2021
Copyright (c) 1997-2021 University of Cambridge.
------------------------------------------------------------------------------


PCRE2API(3) Library Functions Manual PCRE2API(3)


Expand Down Expand Up @@ -3851,8 +3851,8 @@ REVISION
Last updated: 30 August 2021
Copyright (c) 1997-2021 University of Cambridge.
------------------------------------------------------------------------------


PCRE2BUILD(3) Library Functions Manual PCRE2BUILD(3)


Expand Down Expand Up @@ -4445,8 +4445,8 @@ REVISION
Last updated: 20 March 2020
Copyright (c) 1997-2020 University of Cambridge.
------------------------------------------------------------------------------


PCRE2CALLOUT(3) Library Functions Manual PCRE2CALLOUT(3)


Expand Down Expand Up @@ -4875,8 +4875,8 @@ REVISION
Last updated: 03 February 2019
Copyright (c) 1997-2019 University of Cambridge.
------------------------------------------------------------------------------


PCRE2COMPAT(3) Library Functions Manual PCRE2COMPAT(3)


Expand Down Expand Up @@ -5090,8 +5090,8 @@ REVISION
Last updated: 30 August 2021
Copyright (c) 1997-2021 University of Cambridge.
------------------------------------------------------------------------------


PCRE2JIT(3) Library Functions Manual PCRE2JIT(3)


Expand Down Expand Up @@ -5516,8 +5516,8 @@ REVISION
Last updated: 23 May 2019
Copyright (c) 1997-2019 University of Cambridge.
------------------------------------------------------------------------------


PCRE2LIMITS(3) Library Functions Manual PCRE2LIMITS(3)


Expand Down Expand Up @@ -5586,8 +5586,8 @@ REVISION
Last updated: 02 February 2019
Copyright (c) 1997-2019 University of Cambridge.
------------------------------------------------------------------------------


PCRE2MATCHING(3) Library Functions Manual PCRE2MATCHING(3)


Expand Down Expand Up @@ -5811,8 +5811,8 @@ REVISION
Last updated: 28 August 2021
Copyright (c) 1997-2021 University of Cambridge.
------------------------------------------------------------------------------


PCRE2PARTIAL(3) Library Functions Manual PCRE2PARTIAL(3)


Expand Down Expand Up @@ -6191,8 +6191,8 @@ REVISION
Last updated: 04 September 2019
Copyright (c) 1997-2019 University of Cambridge.
------------------------------------------------------------------------------


PCRE2PATTERN(3) Library Functions Manual PCRE2PATTERN(3)


Expand Down Expand Up @@ -9641,8 +9641,8 @@ REVISION
Last updated: 30 August 2021
Copyright (c) 1997-2021 University of Cambridge.
------------------------------------------------------------------------------


PCRE2PERFORM(3) Library Functions Manual PCRE2PERFORM(3)


Expand Down Expand Up @@ -9876,8 +9876,8 @@ REVISION
Last updated: 03 February 2019
Copyright (c) 1997-2019 University of Cambridge.
------------------------------------------------------------------------------


PCRE2POSIX(3) Library Functions Manual PCRE2POSIX(3)


Expand Down Expand Up @@ -10210,8 +10210,8 @@ REVISION
Last updated: 26 April 2021
Copyright (c) 1997-2021 University of Cambridge.
------------------------------------------------------------------------------


PCRE2SAMPLE(3) Library Functions Manual PCRE2SAMPLE(3)


Expand Down Expand Up @@ -10489,8 +10489,8 @@ REVISION
Last updated: 27 June 2018
Copyright (c) 1997-2018 University of Cambridge.
------------------------------------------------------------------------------


PCRE2SYNTAX(3) Library Functions Manual PCRE2SYNTAX(3)


Expand Down Expand Up @@ -11009,8 +11009,8 @@ REVISION
Last updated: 30 August 2021
Copyright (c) 1997-2021 University of Cambridge.
------------------------------------------------------------------------------


PCRE2UNICODE(3) Library Functions Manual PCRE2UNICODE(3)


Expand Down Expand Up @@ -11444,5 +11444,5 @@ REVISION
Last updated: 23 February 2020
Copyright (c) 1997-2020 University of Cambridge.
------------------------------------------------------------------------------


8 changes: 4 additions & 4 deletions doc/pcre2_dfa_match.3
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ just once (except when processing lookaround assertions). This function is
\fIworkspace\fP Points to a vector of ints used as working space
\fIwscount\fP Number of elements in the vector
.sp
The size of output vector needed to contain all the results depends on the
number of simultaneous matches, not on the number of parentheses in the
pattern. Using \fBpcre2_match_data_create_from_pattern()\fP to create the match
data block is therefore not advisable when using this function.
The size of output vector needed to contain all the results depends on the
number of simultaneous matches, not on the number of parentheses in the
pattern. Using \fBpcre2_match_data_create_from_pattern()\fP to create the match
data block is therefore not advisable when using this function.
.P
A match context is needed only if you want to set up a callout function or
specify the heap limit or the match or the recursion depth limits. The
Expand Down
2 changes: 1 addition & 1 deletion doc/pcre2_set_compile_extra_options.3
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ housed in a compile context. It completely replaces all the bits. The extra
options are:
.sp
.\" JOIN
PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK Allow \eK in lookarounds
PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK Allow \eK in lookarounds
PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES Allow \ex{df800} to \ex{dfff}
in UTF-8 and UTF-32 modes
.\" JOIN
Expand Down
16 changes: 8 additions & 8 deletions doc/pcre2api.3
Original file line number Diff line number Diff line change
Expand Up @@ -1878,10 +1878,10 @@ The option bits that can be set in a compile context by calling the
.sp
PCRE2_EXTRA_ALLOW_LOOKAROUND_BSK
.sp
Since release 10.38 PCRE2 has forbidden the use of \eK within lookaround
assertions, following Perl's lead. This option is provided to re-enable the
previous behaviour (act in positive lookarounds, ignore in negative ones) in
case anybody is relying on it.
Since release 10.38 PCRE2 has forbidden the use of \eK within lookaround
assertions, following Perl's lead. This option is provided to re-enable the
previous behaviour (act in positive lookarounds, ignore in negative ones) in
case anybody is relying on it.
.sp
PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES
.sp
Expand Down Expand Up @@ -2503,20 +2503,20 @@ string that define the matched parts of the subject. This is known as the
Before calling \fBpcre2_match()\fP, \fBpcre2_dfa_match()\fP, or
\fBpcre2_jit_match()\fP you must create a match data block by calling one of
the creation functions above. For \fBpcre2_match_data_create()\fP, the first
argument is the number of pairs of offsets in the \fIovector\fP.
argument is the number of pairs of offsets in the \fIovector\fP.
.P
When using \fBpcre2_match()\fP, one pair of offsets is required to identify the
string that matched the whole pattern, with an additional pair for each
captured substring. For example, a value of 4 creates enough space to record
the matched portion of the subject plus three captured substrings.
.P
When using \fBpcre2_dfa_match()\fP there may be multiple matched substrings of
When using \fBpcre2_dfa_match()\fP there may be multiple matched substrings of
different lengths at the same point in the subject. The ovector should be made
large enough to hold as many as are expected.
.P
A minimum of at least 1 pair is imposed by \fBpcre2_match_data_create()\fP, so
it is always possible to return the overall matched string in the case of
\fBpcre2_match()\fP or the longest match in the case of
it is always possible to return the overall matched string in the case of
\fBpcre2_match()\fP or the longest match in the case of
\fBpcre2_dfa_match()\fP.
.P
The second argument of \fBpcre2_match_data_create()\fP is a pointer to a
Expand Down
6 changes: 3 additions & 3 deletions doc/pcre2demo.3
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,11 @@ pcre2_match_data_create_from_pattern() above. */
if (rc == 0)
printf("ovector was not big enough for all the captured substrings\en");
/* Since release 10.38 PCRE2 has locked out the use of \eK in lookaround
assertions. However, there is an option to re-enable the old behaviour. If that
/* Since release 10.38 PCRE2 has locked out the use of \eK in lookaround
assertions. However, there is an option to re-enable the old behaviour. If that
is set, it is possible to run patterns such as /(?=.\eK)/ that use \eK in an
assertion to set the start of a match later than its end. In this demonstration
program, we show how to detect this case, but it shouldn't arise because the
program, we show how to detect this case, but it shouldn't arise because the
option is never set. */
if (ovector[0] > ovector[1])
Expand Down

0 comments on commit 8f3e11a

Please sign in to comment.