diff options
| author | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2011-08-13 12:27:51 +0000 |
|---|---|---|
| committer | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2011-08-13 12:27:51 +0000 |
| commit | e1a6406ad8d260675b576163174ed778ed871a6e (patch) | |
| tree | 6566c21e2c98b2053e3f73c61f8e6de77aa67e40 /doc | |
| parent | 410d7f7fd6aa3419dcf92329d46ddc916023824e (diff) | |
| download | pcre-e1a6406ad8d260675b576163174ed778ed871a6e.tar.gz | |
Clarify PCRE_INFO_STUDYSIZE in documentation.
git-svn-id: svn://vcs.exim.org/pcre/code/trunk@656 2f5784b3-3f2a-0410-8824-cb99058d5e15
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/html/index.html | 16 | ||||
| -rw-r--r-- | doc/html/pcreapi.html | 24 | ||||
| -rw-r--r-- | doc/pcre.txt | 76 | ||||
| -rw-r--r-- | doc/pcreapi.3 | 29 |
4 files changed, 84 insertions, 61 deletions
diff --git a/doc/html/index.html b/doc/html/index.html index d9af7e1..58dfe45 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -1,10 +1,10 @@ <html> -<!-- This is a manually maintained file that is the root of the HTML version of - the PCRE documentation. When the HTML documents are built from the man - page versions, the entire doc/html directory is emptied, this file is then - copied into doc/html/index.html, and the remaining files therein are +<!-- This is a manually maintained file that is the root of the HTML version of + the PCRE documentation. When the HTML documents are built from the man + page versions, the entire doc/html directory is emptied, this file is then + copied into doc/html/index.html, and the remaining files therein are created by the 132html script. ---> +--> <head> <title>PCRE specification</title> </head> @@ -74,11 +74,11 @@ The HTML documentation for PCRE comprises the following pages: </table> <p> -There are also individual pages that summarize the interface for each function +There are also individual pages that summarize the interface for each function in the library: </p> -<table> +<table> <tr><td><a href="pcre_compile.html">pcre_compile</a></td> <td> Compile a regular expression</td></tr> @@ -129,7 +129,7 @@ in the library: <tr><td><a href="pcre_maketables.html">pcre_maketables</a></td> <td> Build character tables in current locale</td></tr> - + <tr><td><a href="pcre_refcount.html">pcre_refcount</a></td> <td> Maintain reference count in compiled pattern</td></tr> diff --git a/doc/html/pcreapi.html b/doc/html/pcreapi.html index 4c09656..6d81409 100644 --- a/doc/html/pcreapi.html +++ b/doc/html/pcreapi.html @@ -770,7 +770,7 @@ out of use. To avoid confusion, they have not been re-used. 34 character value in \x{...} sequence is too large 35 invalid condition (?(0) 36 \C not allowed in lookbehind assertion - 37 PCRE does not support \L, \l, \N, \U, or \u + 37 PCRE does not support \L, \l, \N{name}, \U, or \u 38 number after (?C is > 255 39 closing ) for (?C expected 40 recursive call could loop indefinitely @@ -804,10 +804,12 @@ out of use. To avoid confusion, they have not been re-used. not allowed 66 (*MARK) must have an argument 67 this version of PCRE is not compiled with PCRE_UCP support + 68 \c must be followed by an ASCII character + 69 \k is not followed by a braced, angle-bracketed, or quoted name </pre> The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may be used if the limits were changed when PCRE was built. -</P> +<a name="studyingapattern"></a></P> <br><a name="SEC9" href="#TOC1">STUDYING A PATTERN</a><br> <P> <b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i></b> @@ -1155,12 +1157,16 @@ variable. <pre> PCRE_INFO_STUDYSIZE </pre> -Return the size of the data block pointed to by the <i>study_data</i> field in -a <b>pcre_extra</b> block. That is, it is the value that was passed to -<b>pcre_malloc()</b> when PCRE was getting memory into which to place the data -created by <b>pcre_study()</b>. If <b>pcre_extra</b> is NULL, or there is no -study data, zero is returned. The fourth argument should point to a -<b>size_t</b> variable. +Return the size of the data block pointed to by the <i>study_data</i> field in a +<b>pcre_extra</b> block. If <b>pcre_extra</b> is NULL, or there is no study data, +zero is returned. The fourth argument should point to a <b>size_t</b> variable. +The <i>study_data</i> field is set by <b>pcre_study()</b> to record information +that will speed up matching (see the section entitled +<a href="#studyingapattern">"Studying a pattern"</a> +above). The format of the <i>study_data</i> block is private, but its length +is made available via this option so that it can be saved and restored (see the +<a href="pcreprecompile.html"><b>pcreprecompile</b></a> +documentation for details). </P> <br><a name="SEC12" href="#TOC1">OBSOLETE INFO FUNCTION</a><br> <P> @@ -2343,7 +2349,7 @@ Cambridge CB2 3QH, England. </P> <br><a name="SEC22" href="#TOC1">REVISION</a><br> <P> -Last updated: 28 July 2011 +Last updated: 13 August 2011 <br> Copyright © 1997-2011 University of Cambridge. <br> diff --git a/doc/pcre.txt b/doc/pcre.txt index cb9bd0e..b79054e 100644 --- a/doc/pcre.txt +++ b/doc/pcre.txt @@ -2,7 +2,7 @@ This file contains a concatenation of the PCRE man pages, converted to plain text format for ease of searching with a text editor, or for use on systems that do not have a man page processor. The small individual files that give -synopses of each function in the library have not been included. Neither has +synopses of each function in the library have not been included. Neither has the pcredemo program. There are separate text files for the pcregrep and pcretest commands. ----------------------------------------------------------------------------- @@ -275,8 +275,8 @@ REVISION Last updated: 07 May 2011 Copyright (c) 1997-2011 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCREBUILD(3) PCREBUILD(3) @@ -622,8 +622,8 @@ REVISION Last updated: 02 August 2011 Copyright (c) 1997-2011 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCREMATCHING(3) PCREMATCHING(3) @@ -826,8 +826,8 @@ REVISION Last updated: 17 November 2010 Copyright (c) 1997-2010 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCREAPI(3) PCREAPI(3) @@ -1514,7 +1514,7 @@ COMPILATION ERROR CODES 34 character value in \x{...} sequence is too large 35 invalid condition (?(0) 36 \C not allowed in lookbehind assertion - 37 PCRE does not support \L, \l, \N, \U, or \u + 37 PCRE does not support \L, \l, \N{name}, \U, or \u 38 number after (?C is > 255 39 closing ) for (?C expected 40 recursive call could loop indefinitely @@ -1548,6 +1548,8 @@ COMPILATION ERROR CODES not allowed 66 (*MARK) must have an argument 67 this version of PCRE is not compiled with PCRE_UCP support + 68 \c must be followed by an ASCII character + 69 \k is not followed by a braced, angle-bracketed, or quoted name The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may be used if the limits were changed when PCRE was built. @@ -1886,11 +1888,13 @@ INFORMATION ABOUT A PATTERN PCRE_INFO_STUDYSIZE Return the size of the data block pointed to by the study_data field in - a pcre_extra block. That is, it is the value that was passed to - pcre_malloc() when PCRE was getting memory into which to place the data - created by pcre_study(). If pcre_extra is NULL, or there is no study - data, zero is returned. The fourth argument should point to a size_t - variable. + a pcre_extra block. If pcre_extra is NULL, or there is no study data, + zero is returned. The fourth argument should point to a size_t vari- + able. The study_data field is set by pcre_study() to record informa- + tion that will speed up matching (see the section entitled "Studying a + pattern" above). The format of the study_data block is private, but its + length is made available via this option so that it can be saved and + restored (see the pcreprecompile documentation for details). OBSOLETE INFO FUNCTION @@ -2991,11 +2995,11 @@ AUTHOR REVISION - Last updated: 28 July 2011 + Last updated: 13 August 2011 Copyright (c) 1997-2011 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRECALLOUT(3) PCRECALLOUT(3) @@ -3183,8 +3187,8 @@ REVISION Last updated: 31 July 2011 Copyright (c) 1997-2011 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRECOMPAT(3) PCRECOMPAT(3) @@ -3350,8 +3354,8 @@ REVISION Last updated: 24 July 2011 Copyright (c) 1997-2011 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCREPATTERN(3) PCREPATTERN(3) @@ -5859,8 +5863,8 @@ REVISION Last updated: 24 July 2011 Copyright (c) 1997-2011 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRESYNTAX(3) PCRESYNTAX(3) @@ -6229,8 +6233,8 @@ REVISION Last updated: 21 November 2010 Copyright (c) 1997-2010 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCREPARTIAL(3) PCREPARTIAL(3) @@ -6649,8 +6653,8 @@ REVISION Last updated: 07 November 2010 Copyright (c) 1997-2010 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCREPRECOMPILE(3) PCREPRECOMPILE(3) @@ -6774,8 +6778,8 @@ REVISION Last updated: 17 November 2010 Copyright (c) 1997-2010 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCREPERFORM(3) PCREPERFORM(3) @@ -6942,8 +6946,8 @@ REVISION Last updated: 16 May 2010 Copyright (c) 1997-2010 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCREPOSIX(3) PCREPOSIX(3) @@ -7205,8 +7209,8 @@ REVISION Last updated: 16 May 2010 Copyright (c) 1997-2010 University of Cambridge. ------------------------------------------------------------------------------ - - + + PCRECPP(3) PCRECPP(3) @@ -7547,8 +7551,8 @@ REVISION Last updated: 17 March 2009 Minor typo fixed: 25 July 2011 ------------------------------------------------------------------------------ - - + + PCRESAMPLE(3) PCRESAMPLE(3) @@ -7785,5 +7789,5 @@ REVISION Last updated: 22 July 2011 Copyright (c) 1997-2011 University of Cambridge. ------------------------------------------------------------------------------ - - + + diff --git a/doc/pcreapi.3 b/doc/pcreapi.3 index 38dce95..d7291a9 100644 --- a/doc/pcreapi.3 +++ b/doc/pcreapi.3 @@ -777,7 +777,7 @@ out of use. To avoid confusion, they have not been re-used. 34 character value in \ex{...} sequence is too large 35 invalid condition (?(0) 36 \eC not allowed in lookbehind assertion - 37 PCRE does not support \eL, \el, \eN, \eU, or \eu + 37 PCRE does not support \eL, \el, \eN{name}, \eU, or \eu 38 number after (?C is > 255 39 closing ) for (?C expected 40 recursive call could loop indefinitely @@ -811,11 +811,14 @@ out of use. To avoid confusion, they have not been re-used. not allowed 66 (*MARK) must have an argument 67 this version of PCRE is not compiled with PCRE_UCP support + 68 \ec must be followed by an ASCII character + 69 \ek is not followed by a braced, angle-bracketed, or quoted name .sp The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may be used if the limits were changed when PCRE was built. . . +.\" HTML <a name="studyingapattern"></a> .SH "STUDYING A PATTERN" .rs .sp @@ -1165,12 +1168,21 @@ variable. .sp PCRE_INFO_STUDYSIZE .sp -Return the size of the data block pointed to by the \fIstudy_data\fP field in -a \fBpcre_extra\fP block. That is, it is the value that was passed to -\fBpcre_malloc()\fP when PCRE was getting memory into which to place the data -created by \fBpcre_study()\fP. If \fBpcre_extra\fP is NULL, or there is no -study data, zero is returned. The fourth argument should point to a -\fBsize_t\fP variable. +Return the size of the data block pointed to by the \fIstudy_data\fP field in a +\fBpcre_extra\fP block. If \fBpcre_extra\fP is NULL, or there is no study data, +zero is returned. The fourth argument should point to a \fBsize_t\fP variable. +The \fIstudy_data\fP field is set by \fBpcre_study()\fP to record information +that will speed up matching (see the section entitled +.\" HTML <a href="#studyingapattern"> +.\" </a> +"Studying a pattern" +.\" +above). The format of the \fIstudy_data\fP block is private, but its length +is made available via this option so that it can be saved and restored (see the +.\" HREF +\fBpcreprecompile\fP +.\" +documentation for details). . . .SH "OBSOLETE INFO FUNCTION" @@ -1265,6 +1277,7 @@ Here is an example of a simple call to \fBpcre_exec()\fP: ovector, /* vector of integers for substring information */ 30); /* number of elements (NOT size in bytes) */ . +. .\" HTML <a name="extradata"></a> .SS "Extra data for \fBpcre_exec()\fR" .rs @@ -2379,6 +2392,6 @@ Cambridge CB2 3QH, England. .rs .sp .nf -Last updated: 28 July 2011 +Last updated: 13 August 2011 Copyright (c) 1997-2011 University of Cambridge. .fi |