Annotation of embedaddon/pcre/doc/pcre_jit_stack_alloc.3, revision 1.1
1.1 ! misho 1: .TH PCRE_JIT_STACK_ALLOC 3
! 2: .SH NAME
! 3: PCRE - Perl-compatible regular expressions
! 4: .SH SYNOPSIS
! 5: .rs
! 6: .sp
! 7: .B #include <pcre.h>
! 8: .PP
! 9: .SM
! 10: .B pcre_jit_stack *pcre_jit_stack_alloc(int \fIstartsize\fP,
! 11: .ti +5n
! 12: .B int \fImaxsize\fP);
! 13: .
! 14: .SH DESCRIPTION
! 15: .rs
! 16: .sp
! 17: This function is used to create a stack for use by the code compiled by the JIT
! 18: optimization of \fBpcre_study()\fP. The arguments are a starting size for the
! 19: stack, and a maximum size to which it is allowed to grow. The result can be
! 20: passed to the JIT runtime code by \fBpcre_assign_jit_stack()\fP, or that
! 21: function can set up a callback for obtaining a stack. A maximum stack size of
! 22: 512K to 1M should be more than enough for any pattern. For more details, see
! 23: the
! 24: .\" HREF
! 25: \fBpcrejit\fP
! 26: .\"
! 27: page.
! 28: .P
! 29: There is a complete description of the PCRE native API in the
! 30: .\" HREF
! 31: \fBpcreapi\fP
! 32: .\"
! 33: page and a description of the POSIX API in the
! 34: .\" HREF
! 35: \fBpcreposix\fP
! 36: .\"
! 37: page.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>