Add user data to recursion guard; get ready for RC1 (again)

git-svn-id: svn://vcs.exim.org/pcre2/code/trunk@164 6239d852-aaf2-0410-a92c-79f79f948069

1 files changed, 7 insertions, 6 deletions

diff --git a/doc/pcre2_set_compile_recursion_guard.3 b/doc/pcre2_set_compile_recursion_guard.3
index 96f1566..0575f94 100644
--- a/doc/pcre2_set_compile_recursion_guard.3
+++ b/doc/pcre2_set_compile_recursion_guard.3
@@ -8,7 +8,7 @@ PCRE2 - Perl-compatible regular expressions (revised API)
 .PP
 .nf
 .B int pcre2_set_compile_recursion_guard(pcre2_compile_context *\fIccontext\fP,
-.B "  int (*\fIguard_function\fP)(uint32_t));"
+.B "  int (*\fIguard_function\fP)(uint32_t, void *), void *\fIuser_data\fP);"
 .fi
 .
 .SH DESCRIPTION
@@ -16,11 +16,12 @@ PCRE2 - Perl-compatible regular expressions (revised API)
 .sp
 This function defines, within a compile context, a function that is called
 whenever \fBpcre2_compile()\fP starts to compile a parenthesized part of a
-pattern. The argument to the function gives the current depth of parenthesis
-nesting. The function should return zero if all is well, or non-zero to force
-an error. This feature is provided so that applications can check the available
-system stack space, in order to avoid running out. The result of this function
-is always zero.
+pattern. The first argument to the function gives the current depth of
+parenthesis nesting, and the second is user data that is supplied when the
+function is set up. The callout function should return zero if all is well, or
+non-zero to force an error. This feature is provided so that applications can
+check the available system stack space, in order to avoid running out. The
+result of \fBpcre2_set_compile_recursion_guard()\fP is always zero.
 .P
 There is a complete description of the PCRE2 native API in the
 .\" HREF