Skip to content

Commit be286bf

Browse files
committed
Small PR review tweaks
1 parent 9bda686 commit be286bf

File tree

4 files changed

+21
-20
lines changed

4 files changed

+21
-20
lines changed

doc/html/pcre2api.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1374,7 +1374,7 @@ <h2><a name="SEC19" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a></h2>
13741374
<pre>
13751375
PCRE2_CONFIG_JITTARGET
13761376
</pre>
1377-
The <i>where</i> argument should point to a PCRE2_UCHAR-aligned buffer. All
1377+
The <i>where</i> argument should point to a code-unit-aligned buffer. All
13781378
previous versions of PCRE2 have required no more than 128 code units of buffer
13791379
capacity. However, this requirement is not guaranteed to be maintained, so
13801380
applications should call <b>pcre2_config()</b> with <b>where</b> set to NULL to
@@ -1454,7 +1454,7 @@ <h2><a name="SEC19" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a></h2>
14541454
<pre>
14551455
PCRE2_CONFIG_UNICODE_VERSION
14561456
</pre>
1457-
The <i>where</i> argument should point to a PCRE2_UCHAR-aligned buffer. All
1457+
The <i>where</i> argument should point to a code-unit-aligned buffer. All
14581458
previous versions of PCRE2 have required no more than 24 code units of buffer
14591459
capacity. However, applications should call <b>pcre2_config()</b> with
14601460
<b>where</b> set to NULL to receive the required buffer size, then assert or
@@ -1471,7 +1471,7 @@ <h2><a name="SEC19" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a></h2>
14711471
<pre>
14721472
PCRE2_CONFIG_VERSION
14731473
</pre>
1474-
The <i>where</i> argument should point to a PCRE2_UCHAR-aligned buffer. All
1474+
The <i>where</i> argument should point to a code-unit-aligned buffer. All
14751475
previous versions of PCRE2 have required no more than 24 code units of buffer
14761476
capacity. However, applications should call <b>pcre2_config()</b> with
14771477
<b>where</b> set to NULL to receive the required buffer size, then assert or

doc/pcre2.txt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1364,8 +1364,8 @@ CHECKING BUILD-TIME OPTIONS
13641364

13651365
PCRE2_CONFIG_JITTARGET
13661366

1367-
The where argument should point to a PCRE2_UCHAR-aligned buffer. All
1368-
previous versions of PCRE2 have required no more than 128 code units of
1367+
The where argument should point to a code-unit-aligned buffer. All pre-
1368+
vious versions of PCRE2 have required no more than 128 code units of
13691369
buffer capacity. However, this requirement is not guaranteed to be
13701370
maintained, so applications should call pcre2_config() with where set
13711371
to NULL to receive the required buffer size, then assert or allocate a
@@ -1446,27 +1446,27 @@ CHECKING BUILD-TIME OPTIONS
14461446

14471447
PCRE2_CONFIG_UNICODE_VERSION
14481448

1449-
The where argument should point to a PCRE2_UCHAR-aligned buffer. All
1450-
previous versions of PCRE2 have required no more than 24 code units of
1451-
buffer capacity. However, applications should call pcre2_config() with
1452-
where set to NULL to receive the required buffer size, then assert or
1449+
The where argument should point to a code-unit-aligned buffer. All pre-
1450+
vious versions of PCRE2 have required no more than 24 code units of
1451+
buffer capacity. However, applications should call pcre2_config() with
1452+
where set to NULL to receive the required buffer size, then assert or
14531453
allocate a suitably-size buffer for a second call to pcre2_config(). If
1454-
PCRE2 has been compiled without Unicode support, the buffer is filled
1455-
with the text "Unicode not supported". Otherwise, the Unicode version
1454+
PCRE2 has been compiled without Unicode support, the buffer is filled
1455+
with the text "Unicode not supported". Otherwise, the Unicode version
14561456
string (for example, "8.0.0") is written. The number of code units used
1457-
is returned. This is the length of the string plus one unit for the
1457+
is returned. This is the length of the string plus one unit for the
14581458
terminating zero.
14591459

14601460
PCRE2_CONFIG_UNICODE
14611461

1462-
The output is a uint32_t integer that is set to one if Unicode support
1463-
is available; otherwise it is set to zero. Unicode support implies UTF
1462+
The output is a uint32_t integer that is set to one if Unicode support
1463+
is available; otherwise it is set to zero. Unicode support implies UTF
14641464
support.
14651465

14661466
PCRE2_CONFIG_VERSION
14671467

1468-
The where argument should point to a PCRE2_UCHAR-aligned buffer. All
1469-
previous versions of PCRE2 have required no more than 24 code units of
1468+
The where argument should point to a code-unit-aligned buffer. All pre-
1469+
vious versions of PCRE2 have required no more than 24 code units of
14701470
buffer capacity. However, applications should call pcre2_config() with
14711471
where set to NULL to receive the required buffer size, then assert or
14721472
allocate a suitably-size buffer for a second call to pcre2_config().

doc/pcre2api.3

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1296,7 +1296,7 @@ documentation for more details.
12961296
.sp
12971297
PCRE2_CONFIG_JITTARGET
12981298
.sp
1299-
The \fIwhere\fP argument should point to a PCRE2_UCHAR-aligned buffer. All
1299+
The \fIwhere\fP argument should point to a code-unit-aligned buffer. All
13001300
previous versions of PCRE2 have required no more than 128 code units of buffer
13011301
capacity. However, this requirement is not guaranteed to be maintained, so
13021302
applications should call \fBpcre2_config()\fP with \fBwhere\fP set to NULL to
@@ -1377,7 +1377,7 @@ below.
13771377
.sp
13781378
PCRE2_CONFIG_UNICODE_VERSION
13791379
.sp
1380-
The \fIwhere\fP argument should point to a PCRE2_UCHAR-aligned buffer. All
1380+
The \fIwhere\fP argument should point to a code-unit-aligned buffer. All
13811381
previous versions of PCRE2 have required no more than 24 code units of buffer
13821382
capacity. However, applications should call \fBpcre2_config()\fP with
13831383
\fBwhere\fP set to NULL to receive the required buffer size, then assert or
@@ -1394,7 +1394,7 @@ available; otherwise it is set to zero. Unicode support implies UTF support.
13941394
.sp
13951395
PCRE2_CONFIG_VERSION
13961396
.sp
1397-
The \fIwhere\fP argument should point to a PCRE2_UCHAR-aligned buffer. All
1397+
The \fIwhere\fP argument should point to a code-unit-aligned buffer. All
13981398
previous versions of PCRE2 have required no more than 24 code units of buffer
13991399
capacity. However, applications should call \fBpcre2_config()\fP with
14001400
\fBwhere\fP set to NULL to receive the required buffer size, then assert or

src/pcre2test_inc.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,8 @@ return 0;
559559
Arguments:
560560
what the item to read
561561
562-
Returns: a buffer which must be freed by the caller
562+
Returns: a buffer which must be freed by the caller, where the string has
563+
been written
563564
*/
564565

565566
static char *

0 commit comments

Comments
 (0)