diff options
author | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2018-08-13 11:57:09 +0000 |
---|---|---|
committer | ph10 <ph10@6239d852-aaf2-0410-a92c-79f79f948069> | 2018-08-13 11:57:09 +0000 |
commit | cda75c98a6c0c1ea2efdc2861134fff4d71cf85e (patch) | |
tree | 66e18f00d3775d4858c295e31d8c2d33a84a2a80 /doc/pcre2api.3 | |
parent | 969454248f0219bdf200f602bdc17bccbceea906 (diff) | |
download | pcre2-cda75c98a6c0c1ea2efdc2861134fff4d71cf85e.tar.gz |
File tidies and documentation update for 10.32-RC1 Release Candidate.
git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@983 6239d852-aaf2-0410-a92c-79f79f948069
Diffstat (limited to 'doc/pcre2api.3')
-rw-r--r-- | doc/pcre2api.3 | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/pcre2api.3 b/doc/pcre2api.3 index f13373c..5a97739 100644 --- a/doc/pcre2api.3 +++ b/doc/pcre2api.3 @@ -453,8 +453,8 @@ been matched by \fBpcre2_match()\fP. They are: \fBpcre2_substring_number_from_name()\fP .sp \fBpcre2_substring_free()\fP and \fBpcre2_substring_list_free()\fP are also -provided, to free memory used for extracted strings. If either of these -functions is called with a NULL argument, the function returns immediately +provided, to free memory used for extracted strings. If either of these +functions is called with a NULL argument, the function returns immediately without doing anything. .P The function \fBpcre2_substitute()\fP can be called to match a pattern and @@ -1182,7 +1182,7 @@ If the compile context argument \fIccontext\fP is NULL, memory for the compiled pattern is obtained by calling \fBmalloc()\fP. Otherwise, it is obtained from the same memory function that was used for the compile context. The caller must free the memory by calling \fBpcre2_code_free()\fP when it is no longer needed. -If \fBpcre2_code_free()\fP is called with a NULL argument, it returns +If \fBpcre2_code_free()\fP is called with a NULL argument, it returns immediately, without doing anything. .P The function \fBpcre2_code_copy()\fP makes a copy of the compiled code in new @@ -1194,7 +1194,7 @@ below), .\" the JIT information cannot be copied (because it is position-dependent). The new copy can initially be used only for non-JIT matching, though it can be -passed to \fBpcre2_jit_compile()\fP if required. If \fBpcre2_code_copy()\fP is +passed to \fBpcre2_jit_compile()\fP if required. If \fBpcre2_code_copy()\fP is called with a NULL argument, it returns NULL. .P The \fBpcre2_code_copy()\fP function provides a way for individual threads in a @@ -1448,17 +1448,17 @@ and between a quantifier and a following + that indicates possessiveness. PCRE2_EXTENDED is equivalent to Perl's /x option, and it can be changed within a pattern by a (?x) option setting. .P -When PCRE2 is compiled without Unicode support, PCRE2_EXTENDED recognizes as -white space only those characters with code points less than 256 that are -flagged as white space in its low-character table. The table is normally -created by +When PCRE2 is compiled without Unicode support, PCRE2_EXTENDED recognizes as +white space only those characters with code points less than 256 that are +flagged as white space in its low-character table. The table is normally +created by .\" HREF -\fBpcre2_maketables()\fP, +\fBpcre2_maketables()\fP, .\" which uses the \fBisspace()\fP function to identify space characters. In most ASCII environments, the relevant characters are those with code points 0x0009 (tab), 0x000A (linefeed), 0x000B (vertical tab), 0x000C (formfeed), 0x000D -(carriage return), and 0x0020 (space). +(carriage return), and 0x0020 (space). .P When PCRE2 is compiled with Unicode support, in addition to these characters, five more Unicode "Pattern White Space" characters are recognized by @@ -1488,8 +1488,8 @@ built. PCRE2_EXTENDED_MORE .sp This option has the effect of PCRE2_EXTENDED, 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 +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. PCRE2_EXTENDED_MORE is equivalent to Perl's /xx option, and it can be changed within a pattern by a (?xx) option setting. @@ -2288,7 +2288,7 @@ reloaded must be running the same version of PCRE2, with the same code unit width, and must also have the same endianness, pointer width, and PCRE2_SIZE type. Before compiled patterns can be saved, they must be converted to a "serialized" form, which in the case of PCRE2 is really just a bytecode dump. -The functions whose names begin with \fBpcre2_serialize_\fP are used for +The functions whose names begin with \fBpcre2_serialize_\fP are used for converting to and from the serialized form. They are described in the .\" HREF \fBpcre2serialize\fP @@ -2366,7 +2366,7 @@ free a compiled pattern or a subject string until after all operations on the match data block (for that match) have taken place. .P When a match data block itself is no longer needed, it should be freed by -calling \fBpcre2_match_data_free()\fP. If this function is called with a NULL +calling \fBpcre2_match_data_free()\fP. If this function is called with a NULL argument, it returns immediately, without doing anything. . . @@ -3370,7 +3370,7 @@ replacement string, with more particular errors being PCRE2_ERROR_BADREPESCAPE (invalid escape sequence), PCRE2_ERROR_REPMISSINGBRACE (closing curly bracket not found), PCRE2_ERROR_BADSUBSTITUTION (syntax error in extended group substitution), and PCRE2_ERROR_BADSUBSPATTERN (the pattern match ended before -it started or the match started earlier than the current position in the +it started or the match started earlier than the current position in the subject, which can happen if \eK is used in an assertion). .P As for all PCRE2 errors, a text message that describes the error can be |