Skip to content

Commit e1007ac

Browse files
committed
doc: deprecate use of static buffers for JITTARGET
1 parent a631e0c commit e1007ac

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

doc/pcre2api.3

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH PCRE2API 3 "19 October 2025" "PCRE2 10.48-DEV"
1+
.TH PCRE2API 3 "29 October 2025" "PCRE2 10.48-DEV"
22
.SH NAME
33
PCRE2 - Perl-compatible regular expressions (revised API)
44
.sp
@@ -1297,13 +1297,14 @@ documentation for more details.
12971297
PCRE2_CONFIG_JITTARGET
12981298
.sp
12991299
The \fIwhere\fP argument should point to a buffer that is suitably aligned and
1300-
at least 128 code units long. (The exact length required can be found by calling
1301-
\fBpcre2_config()\fP with \fBwhere\fP set to NULL.) The buffer is filled with a
1302-
string that contains the name of the architecture for which the JIT compiler is
1303-
configured, for example "x86 32bit (little endian + unaligned)". If JIT support
1304-
is not available, PCRE2_ERROR_BADOPTION is returned, otherwise the number of
1305-
code units used is returned. This is the length of the string, plus one unit
1306-
for the terminating zero.
1300+
wide enough to hold the full string. The exact length required is returned when
1301+
calling \fBpcre2_config()\fP with \fBwhere\fP set to NULL first. The buffer is
1302+
filled with a string that contains the name of the architecture for which the JIT
1303+
compiler is configured at build time, for example, a 64-bit ARM CPU that supports
1304+
the Armv8.1 extension writes "ARM-64 (LSE) 64bit (little endian + unaligned)".
1305+
If JIT support is not available, PCRE2_ERROR_BADOPTION is returned, otherwise
1306+
the number of code units used is returned. This is the length of the string,
1307+
plus one code unit for the NUL character.
13071308
.sp
13081309
PCRE2_CONFIG_LINKSIZE
13091310
.sp
@@ -4606,6 +4607,6 @@ Cambridge, England.
46064607
.rs
46074608
.sp
46084609
.nf
4609-
Last updated: 19 October 2025
4610+
Last updated: 29 October 2025
46104611
Copyright (c) 1997-2024 University of Cambridge.
46114612
.fi

0 commit comments

Comments
 (0)