Skip to content

Further updates to pcre2_config docs, and remove pcre2test's VERSION_SIZE #836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 1, 2025
+1,298 −1,271
Merged

Further updates to pcre2_config docs, and remove pcre2test's VERSION_SIZE #836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bda686
Further updates to pcre2_config docs, and remove pcre2test's VERSION_…
NWilson Oct 30, 2025
be286bf
Small PR review tweaks
NWilson Nov 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 29 additions & 22 deletions doc/html/pcre2api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1374,15 +1374,18 @@ <h2><a name="SEC19" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a></h2>
<pre>
PCRE2_CONFIG_JITTARGET
</pre>
The <i>where</i> argument should point to a buffer that is suitably aligned and
wide enough to hold the full string. The exact length required is returned when
calling <b>pcre2_config()</b> with <b>where</b> set to NULL first. The buffer is
filled with a string that contains the name of the architecture for which the JIT
compiler is configured at build time, for example, a 64-bit ARM CPU that supports
the Armv8.1 extension writes "ARM-64 (LSE) 64bit (little endian + unaligned)".
If JIT support is not available, PCRE2_ERROR_BADOPTION is returned, otherwise
the number of code units used is returned. This is the length of the string,
plus one code unit for the NUL character.
The <i>where</i> argument should point to a code-unit-aligned buffer. All
previous versions of PCRE2 have required no more than 128 code units of buffer
capacity. However, this requirement is not guaranteed to be maintained, so
applications should call <b>pcre2_config()</b> with <b>where</b> set to NULL to
receive the required buffer size, then assert or allocate a suitably-size buffer
for a second call to <b>pcre2_config()</b>. The buffer is filled with a string
that contains the name of the architecture for which the JIT compiler is
configured at build time, for example, a 64-bit ARM CPU that supports the
Armv8.1 extension writes "ARM-64 (LSE) 64bit (little endian + unaligned)". If
JIT support is not available, PCRE2_ERROR_BADOPTION is returned; otherwise the
number of code units used is returned. This is the length of the string plus one
unit for the terminating zero.
<pre>
PCRE2_CONFIG_LINKSIZE
</pre>
Expand Down Expand Up @@ -1451,13 +1454,15 @@ <h2><a name="SEC19" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a></h2>
<pre>
PCRE2_CONFIG_UNICODE_VERSION
</pre>
The <i>where</i> argument should point to a buffer that is at least 24 code
units long. (The exact length required can be found by calling
<b>pcre2_config()</b> with <b>where</b> set to NULL.) If PCRE2 has been compiled
without Unicode support, the buffer is filled with the text "Unicode not
supported". Otherwise, the Unicode version string (for example, "8.0.0") is
inserted. The number of code units used is returned. This is the length of the
string plus one unit for the terminating zero.
The <i>where</i> argument should point to a code-unit-aligned buffer. All
previous versions of PCRE2 have required no more than 24 code units of buffer
capacity. However, applications should call <b>pcre2_config()</b> with
<b>where</b> set to NULL to receive the required buffer size, then assert or
allocate a suitably-size buffer for a second call to <b>pcre2_config()</b>. If
PCRE2 has been compiled without Unicode support, the buffer is filled with the
text "Unicode not supported". Otherwise, the Unicode version string (for
example, "8.0.0") is written. The number of code units used is returned. This is
the length of the string plus one unit for the terminating zero.
<pre>
PCRE2_CONFIG_UNICODE
</pre>
Expand All @@ -1466,12 +1471,14 @@ <h2><a name="SEC19" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a></h2>
<pre>
PCRE2_CONFIG_VERSION
</pre>
The <i>where</i> argument should point to a buffer that is at least 24 code
units long. (The exact length required can be found by calling
<b>pcre2_config()</b> with <b>where</b> set to NULL.) The buffer is filled with
the PCRE2 version string, zero-terminated. The number of code units used is
returned. This is the length of the string plus one unit for the terminating
zero.
The <i>where</i> argument should point to a code-unit-aligned buffer. All
previous versions of PCRE2 have required no more than 24 code units of buffer
capacity. However, applications should call <b>pcre2_config()</b> with
<b>where</b> set to NULL to receive the required buffer size, then assert or
allocate a suitably-size buffer for a second call to <b>pcre2_config()</b>. The
buffer is filled with the PCRE2 version string, zero-terminated. The number of
code units used is returned. This is the length of the string plus one unit for
the terminating zero.
<a name="compiling"></a></p>
<h2><a name="SEC20" href="#TOC1">COMPILING A PATTERN</a></h2>
<p>
Expand Down
Loading
Loading