diff options
author | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2020-11-06 17:27:35 +0000 |
---|---|---|
committer | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2020-11-06 17:27:35 +0000 |
commit | 87627ed32d92f9f69d11a71d1c14227d8007af19 (patch) | |
tree | 511204737589db272d0900c285c2b9283f2069ed /doc | |
parent | a8d49f666674af7d0d2588f324f16cf49c4925b3 (diff) | |
download | pcre2-87627ed32d92f9f69d11a71d1c14227d8007af19.tar.gz |
File tidies for 10.36-RC1
git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@1283 6239d852-aaf2-0410-a92c-79f79f948069
Diffstat (limited to 'doc')
-rw-r--r-- | doc/html/README.txt | 6 | ||||
-rw-r--r-- | doc/html/pcre2api.html | 4 | ||||
-rw-r--r-- | doc/html/pcre2compat.html | 10 | ||||
-rw-r--r-- | doc/html/pcre2grep.html | 16 | ||||
-rw-r--r-- | doc/html/pcre2pattern.html | 2 | ||||
-rw-r--r-- | doc/html/pcre2test.html | 2 | ||||
-rw-r--r-- | doc/pcre2.txt | 60 | ||||
-rw-r--r-- | doc/pcre2api.3 | 4 | ||||
-rw-r--r-- | doc/pcre2compat.3 | 10 | ||||
-rw-r--r-- | doc/pcre2grep.1 | 18 | ||||
-rw-r--r-- | doc/pcre2pattern.3 | 2 | ||||
-rw-r--r-- | doc/pcre2test.1 | 2 |
12 files changed, 68 insertions, 68 deletions
diff --git a/doc/html/README.txt b/doc/html/README.txt index 38f6460..cb4a065 100644 --- a/doc/html/README.txt +++ b/doc/html/README.txt @@ -297,8 +297,8 @@ library. They are also documented in the pcre2build man page. unaddressable. This allows it to detect invalid memory accesses, and is mostly useful for debugging PCRE2 itself. -. In environments where the gcc compiler is used and lcov version 1.6 or above - is installed, if you specify +. In environments where the gcc compiler is used and lcov is installed, if you + specify --enable-coverage @@ -894,4 +894,4 @@ The distribution should contain the files listed below. Philip Hazel Email local part: Philip.Hazel Email domain: gmail.com -Last updated: 22 September 2020 +Last updated: 06 November 2020 diff --git a/doc/html/pcre2api.html b/doc/html/pcre2api.html index e456647..4ca0eb0 100644 --- a/doc/html/pcre2api.html +++ b/doc/html/pcre2api.html @@ -662,11 +662,11 @@ is valid" flag (that can be updated atomically) must be used: if (!pointer_is_valid) { Get a write (unique) lock for pointer - if (!pointer_is_valid) + if (!pointer_is_valid) { pointer = pcre2_compile(... pointer_is_valid = TRUE - } + } } Release the lock Use pointer in pcre2_match() diff --git a/doc/html/pcre2compat.html b/doc/html/pcre2compat.html index 5238918..54fb643 100644 --- a/doc/html/pcre2compat.html +++ b/doc/html/pcre2compat.html @@ -34,13 +34,13 @@ that the next three characters are not "a". It just asserts that the next character is not "a" three times (in principle; PCRE2 optimizes this to run the assertion just once). Perl allows some repeat quantifiers on other assertions, for example, \b* (but not \b{3}, though oddly it does allow ^{3}), but these -do not seem to have any use. PCRE2 does not allow any kind of quantifier on +do not seem to have any use. PCRE2 does not allow any kind of quantifier on non-lookaround assertions. </P> <P> 3. Capture groups that occur inside negative lookaround assertions are counted, but their entries in the offsets vector are set only when a negative assertion -is a condition that has a matching branch (that is, the condition is false). +is a condition that has a matching branch (that is, the condition is false). Perl may set such capture groups in other circumstances. </P> <P> @@ -84,7 +84,7 @@ other character. Note the following examples: \QA\B\E A\B A\B \Q\\E \ \\E </pre> -The \Q...\E sequence is recognized both inside and outside character classes +The \Q...\E sequence is recognized both inside and outside character classes by both PCRE2 and Perl. </P> <P> @@ -152,8 +152,8 @@ in the release at the time of writing (5.32), \p{Lu} and \p{Ll} match all letters, regardless of case, when case independence is specified. </P> <P> -16. From release 5.32.0, Perl locks out the use of \K in lookaround -assertions. In PCRE2, \K is acted on when it occurs in positive assertions, +16. From release 5.32.0, Perl locks out the use of \K in lookaround +assertions. In PCRE2, \K is acted on when it occurs in positive assertions, but is ignored in negative assertions. </P> <P> diff --git a/doc/html/pcre2grep.html b/doc/html/pcre2grep.html index 9280eaf..995e0ea 100644 --- a/doc/html/pcre2grep.html +++ b/doc/html/pcre2grep.html @@ -111,7 +111,7 @@ matching substrings, or if <b>--only-matching</b>, <b>--file-offsets</b>, or (either shown literally, or as an offset), scanning resumes immediately following the match, so that further matches on the same line can be found. If there are multiple patterns, they are all tried on the remainder of the line, -but patterns that follow the one that matched are not tried on the earlier +but patterns that follow the one that matched are not tried on the earlier matched part of the line. </P> <P> @@ -486,7 +486,7 @@ a separate line. Searching normally stops as soon as a matching line is found in a file. However, if the <b>-c</b> (count) option is also used, matching continues in order to obtain the correct count, and those files that have at least one match are listed along with their counts. Using this option with -<b>-c</b> is a way of suppressing the listing of files with no matches that +<b>-c</b> is a way of suppressing the listing of files with no matches that occurs with <b>-c</b> on its own. This option overrides any previous <b>-H</b>, <b>-h</b>, or <b>-L</b> options. </P> @@ -561,12 +561,12 @@ does not work when input is read line by line (see <b>--line-buffered</b>.) </P> <P> <b>-m</b> <i>number</i>, <b>--max-count</b>=<i>number</i> -Stop processing after finding <i>number</i> matching lines, or non-matching +Stop processing after finding <i>number</i> matching lines, or non-matching lines if <b>-v</b> is also set. Any trailing context lines are output after the final match. In multiline mode, each multiline match counts as just one line for this purpose. If this limit is reached when reading the standard input from a regular file, the file is left positioned just after the last matching line. -If <b>-c</b> is also set, the count that is output is never greater than +If <b>-c</b> is also set, the count that is output is never greater than <i>number</i>. This option has no effect if used with <b>-L</b>, <b>-l</b>, or <b>-q</b>, or when just checking for a match in a binary file. </P> @@ -686,7 +686,7 @@ newline; $r by carriage return; $t by tab; $v by vertical tab. <br> $o<digits> or $o{<digits>} is replaced by the character whose code point is the given octal number. In the first form, up to three octal digits are processed. -When more digits are needed in Unicode mode to specify a wide character, the +When more digits are needed in Unicode mode to specify a wide character, the second form must be used. <br> <br> @@ -788,13 +788,13 @@ total would always be zero. Operate in UTF-8 mode. This option is available only if PCRE2 has been compiled with UTF-8 support. All patterns (including those for any <b>--exclude</b> and <b>--include</b> options) and all lines that are scanned must be valid strings -of UTF-8 characters. If an invalid UTF-8 string is encountered, an error +of UTF-8 characters. If an invalid UTF-8 string is encountered, an error occurs. </P> <P> <b>-U</b>, <b>--utf-allow-invalid</b> As <b>--utf</b>, but in addition subject lines may contain invalid UTF-8 code -unit sequences. These can never form part of any pattern match. Patterns +unit sequences. These can never form part of any pattern match. Patterns themselves, however, must still be valid UTF-8 strings. This facility allows valid UTF-8 strings to be sought within arbitrary byte sequences in executable or other binary files. For more details about matching in non-valid UTF-8 @@ -811,7 +811,7 @@ ignored. <P> <b>-v</b>, <b>--invert-match</b> Invert the sense of the match, so that lines which do <i>not</i> match any of -the patterns are the ones that are found. When this option is set, options such +the patterns are the ones that are found. When this option is set, options such as <b>--only-matching</b> and <b>--output</b>, which specify parts of a match that are to be output, are ignored. </P> diff --git a/doc/html/pcre2pattern.html b/doc/html/pcre2pattern.html index b2adf98..9db15b9 100644 --- a/doc/html/pcre2pattern.html +++ b/doc/html/pcre2pattern.html @@ -337,7 +337,7 @@ part of the pattern. If the PCRE2_EXTENDED_MORE option is set, the same applies, but in addition unescaped space and horizontal tab characters are ignored inside a character class. Note: only these two characters are ignored, not the full set of pattern white space characters that are ignored outside a -character class. Option settings can be changed within a pattern; see the +character class. Option settings can be changed within a pattern; see the section entitled <a href="#internaloptions">"Internal Option Setting"</a> below. diff --git a/doc/html/pcre2test.html b/doc/html/pcre2test.html index 2bcc2b3..4a7e55f 100644 --- a/doc/html/pcre2test.html +++ b/doc/html/pcre2test.html @@ -423,7 +423,7 @@ patterns. Modifiers on a pattern can change these settings. This line is used in test files that can also be processed by <b>perltest.sh</b> to confirm that Perl gives the same results as PCRE2. Subsequent tests are checked for the use of <b>pcre2test</b> features that are incompatible with the -<b>perltest.sh</b> script. +<b>perltest.sh</b> script. </P> <P> Patterns must use '/' as their delimiter, and only certain modifiers are diff --git a/doc/pcre2.txt b/doc/pcre2.txt index 5027bfd..365ecc4 100644 --- a/doc/pcre2.txt +++ b/doc/pcre2.txt @@ -180,8 +180,8 @@ REVISION Last updated: 17 September 2018 Copyright (c) 1997-2018 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2API(3) Library Functions Manual PCRE2API(3) @@ -3829,8 +3829,8 @@ REVISION Last updated: 04 November 2020 Copyright (c) 1997-2020 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2BUILD(3) Library Functions Manual PCRE2BUILD(3) @@ -4423,8 +4423,8 @@ REVISION Last updated: 20 March 2020 Copyright (c) 1997-2020 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2CALLOUT(3) Library Functions Manual PCRE2CALLOUT(3) @@ -4853,8 +4853,8 @@ REVISION Last updated: 03 February 2019 Copyright (c) 1997-2019 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2COMPAT(3) Library Functions Manual PCRE2COMPAT(3) @@ -5066,8 +5066,8 @@ REVISION Last updated: 06 October 2020 Copyright (c) 1997-2019 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2JIT(3) Library Functions Manual PCRE2JIT(3) @@ -5491,8 +5491,8 @@ REVISION Last updated: 23 May 2019 Copyright (c) 1997-2019 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2LIMITS(3) Library Functions Manual PCRE2LIMITS(3) @@ -5561,8 +5561,8 @@ REVISION Last updated: 02 February 2019 Copyright (c) 1997-2019 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2MATCHING(3) Library Functions Manual PCRE2MATCHING(3) @@ -5785,8 +5785,8 @@ REVISION Last updated: 23 May 2019 Copyright (c) 1997-2019 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2PARTIAL(3) Library Functions Manual PCRE2PARTIAL(3) @@ -6165,8 +6165,8 @@ REVISION Last updated: 04 September 2019 Copyright (c) 1997-2019 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2PATTERN(3) Library Functions Manual PCRE2PATTERN(3) @@ -9613,8 +9613,8 @@ REVISION Last updated: 06 October 2020 Copyright (c) 1997-2020 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2PERFORM(3) Library Functions Manual PCRE2PERFORM(3) @@ -9848,8 +9848,8 @@ REVISION Last updated: 03 February 2019 Copyright (c) 1997-2019 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2POSIX(3) Library Functions Manual PCRE2POSIX(3) @@ -10178,8 +10178,8 @@ REVISION Last updated: 30 January 2019 Copyright (c) 1997-2019 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2SAMPLE(3) Library Functions Manual PCRE2SAMPLE(3) @@ -10457,8 +10457,8 @@ REVISION Last updated: 27 June 2018 Copyright (c) 1997-2018 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2SYNTAX(3) Library Functions Manual PCRE2SYNTAX(3) @@ -10973,8 +10973,8 @@ REVISION Last updated: 28 December 2019 Copyright (c) 1997-2019 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRE2UNICODE(3) Library Functions Manual PCRE2UNICODE(3) @@ -11408,5 +11408,5 @@ REVISION Last updated: 23 February 2020 Copyright (c) 1997-2020 University of Cambridge. ------------------------------------------------------------------------------ - - + + diff --git a/doc/pcre2api.3 b/doc/pcre2api.3 index 1fee114..148dca6 100644 --- a/doc/pcre2api.3 +++ b/doc/pcre2api.3 @@ -598,11 +598,11 @@ is valid" flag (that can be updated atomically) must be used: if (!pointer_is_valid) { Get a write (unique) lock for pointer - if (!pointer_is_valid) + if (!pointer_is_valid) { pointer = pcre2_compile(... pointer_is_valid = TRUE - } + } } Release the lock Use pointer in pcre2_match() diff --git a/doc/pcre2compat.3 b/doc/pcre2compat.3 index 862d28d..026e664 100644 --- a/doc/pcre2compat.3 +++ b/doc/pcre2compat.3 @@ -22,12 +22,12 @@ that the next three characters are not "a". It just asserts that the next character is not "a" three times (in principle; PCRE2 optimizes this to run the assertion just once). Perl allows some repeat quantifiers on other assertions, for example, \eb* (but not \eb{3}, though oddly it does allow ^{3}), but these -do not seem to have any use. PCRE2 does not allow any kind of quantifier on +do not seem to have any use. PCRE2 does not allow any kind of quantifier on non-lookaround assertions. .P 3. Capture groups that occur inside negative lookaround assertions are counted, but their entries in the offsets vector are set only when a negative assertion -is a condition that has a matching branch (that is, the condition is false). +is a condition that has a matching branch (that is, the condition is false). Perl may set such capture groups in other circumstances. .P 4. The following Perl escape sequences are not supported: \eF, \el, \eL, \eu, @@ -72,7 +72,7 @@ other character. Note the following examples: \eQA\eB\eE A\eB A\eB \eQ\e\eE \e \e\eE .sp -The \eQ...\eE sequence is recognized both inside and outside character classes +The \eQ...\eE sequence is recognized both inside and outside character classes by both PCRE2 and Perl. .P 7. Fairly obviously, PCRE2 does not support the (?{code}) and (??{code}) @@ -132,8 +132,8 @@ always matches an upper case letter. I think Perl has changed in this respect; in the release at the time of writing (5.32), \ep{Lu} and \ep{Ll} match all letters, regardless of case, when case independence is specified. .P -16. From release 5.32.0, Perl locks out the use of \eK in lookaround -assertions. In PCRE2, \eK is acted on when it occurs in positive assertions, +16. From release 5.32.0, Perl locks out the use of \eK in lookaround +assertions. In PCRE2, \eK is acted on when it occurs in positive assertions, but is ignored in negative assertions. .P 17. PCRE2 provides some extensions to the Perl regular expression facilities. diff --git a/doc/pcre2grep.1 b/doc/pcre2grep.1 index b03082b..66377ce 100644 --- a/doc/pcre2grep.1 +++ b/doc/pcre2grep.1 @@ -79,7 +79,7 @@ matching substrings, or if \fB--only-matching\fP, \fB--file-offsets\fP, or (either shown literally, or as an offset), scanning resumes immediately following the match, so that further matches on the same line can be found. If there are multiple patterns, they are all tried on the remainder of the line, -but patterns that follow the one that matched are not tried on the earlier +but patterns that follow the one that matched are not tried on the earlier matched part of the line. .P This behaviour means that the order in which multiple patterns are specified @@ -422,7 +422,7 @@ a separate line. Searching normally stops as soon as a matching line is found in a file. However, if the \fB-c\fP (count) option is also used, matching continues in order to obtain the correct count, and those files that have at least one match are listed along with their counts. Using this option with -\fB-c\fP is a way of suppressing the listing of files with no matches that +\fB-c\fP is a way of suppressing the listing of files with no matches that occurs with \fB-c\fP on its own. This option overrides any previous \fB-H\fP, \fB-h\fP, or \fB-L\fP options. .TP @@ -489,12 +489,12 @@ large processing buffer, this should not be a problem, but the \fB-M\fP option does not work when input is read line by line (see \fB--line-buffered\fP.) .TP \fB-m\fP \fInumber\fP, \fB--max-count\fP=\fInumber\fP -Stop processing after finding \fInumber\fP matching lines, or non-matching +Stop processing after finding \fInumber\fP matching lines, or non-matching lines if \fB-v\fP is also set. Any trailing context lines are output after the final match. In multiline mode, each multiline match counts as just one line for this purpose. If this limit is reached when reading the standard input from a regular file, the file is left positioned just after the last matching line. -If \fB-c\fP is also set, the count that is output is never greater than +If \fB-c\fP is also set, the count that is output is never greater than \fInumber\fP. This option has no effect if used with \fB-L\fP, \fB-l\fP, or \fB-q\fP, or when just checking for a match in a binary file. .TP @@ -598,7 +598,7 @@ newline; $r by carriage return; $t by tab; $v by vertical tab. .sp $o<digits> or $o{<digits>} is replaced by the character whose code point is the given octal number. In the first form, up to three octal digits are processed. -When more digits are needed in Unicode mode to specify a wide character, the +When more digits are needed in Unicode mode to specify a wide character, the second form must be used. .sp $x<digits> or $x{<digits>} is replaced by the character represented by the @@ -686,12 +686,12 @@ total would always be zero. Operate in UTF-8 mode. This option is available only if PCRE2 has been compiled with UTF-8 support. All patterns (including those for any \fB--exclude\fP and \fB--include\fP options) and all lines that are scanned must be valid strings -of UTF-8 characters. If an invalid UTF-8 string is encountered, an error +of UTF-8 characters. If an invalid UTF-8 string is encountered, an error occurs. .TP \fB-U\fP, \fB--utf-allow-invalid\fP As \fB--utf\fP, but in addition subject lines may contain invalid UTF-8 code -unit sequences. These can never form part of any pattern match. Patterns +unit sequences. These can never form part of any pattern match. Patterns themselves, however, must still be valid UTF-8 strings. This facility allows valid UTF-8 strings to be sought within arbitrary byte sequences in executable or other binary files. For more details about matching in non-valid UTF-8 @@ -708,7 +708,7 @@ ignored. .TP \fB-v\fP, \fB--invert-match\fP Invert the sense of the match, so that lines which do \fInot\fP match any of -the patterns are the ones that are found. When this option is set, options such +the patterns are the ones that are found. When this option is set, options such as \fB--only-matching\fP and \fB--output\fP, which specify parts of a match that are to be output, are ignored. .TP @@ -855,7 +855,7 @@ output string, so if you want a newline, you must include it explicitly using the escape $n. For example: .sp pcre2grep '(.)(..(.))(?C"|[$1] [$2] [$3]$n")' <some file> -.sp +.sp Matching continues normally after the string is output. If you want to see only the callout output but not any output from an actual match, you should end the pattern with (*FAIL). diff --git a/doc/pcre2pattern.3 b/doc/pcre2pattern.3 index 93bacb6..dc78e4d 100644 --- a/doc/pcre2pattern.3 +++ b/doc/pcre2pattern.3 @@ -309,7 +309,7 @@ part of the pattern. If the PCRE2_EXTENDED_MORE option is set, the same applies, but in addition unescaped space and horizontal tab characters are ignored inside a character class. Note: only these two characters are ignored, not the full set of pattern white space characters that are ignored outside a -character class. Option settings can be changed within a pattern; see the +character class. Option settings can be changed within a pattern; see the section entitled .\" HTML <a href="#internaloptions"> .\" </a> diff --git a/doc/pcre2test.1 b/doc/pcre2test.1 index 19ab8be..c63f03d 100644 --- a/doc/pcre2test.1 +++ b/doc/pcre2test.1 @@ -372,7 +372,7 @@ patterns. Modifiers on a pattern can change these settings. This line is used in test files that can also be processed by \fBperltest.sh\fP to confirm that Perl gives the same results as PCRE2. Subsequent tests are checked for the use of \fBpcre2test\fP features that are incompatible with the -\fBperltest.sh\fP script. +\fBperltest.sh\fP script. .P Patterns must use '/' as their delimiter, and only certain modifiers are supported. Comment lines, #pattern commands, and #subject commands that set or |