From 4a8f5d104c008b1c154cbbb7d907c48527150bd6 Mon Sep 17 00:00:00 2001
From: Philip Hazel
Date: Sat, 27 Nov 2021 16:32:52 +0000
Subject: [PATCH] Local updates consequent on ocumentation patches (PR#47).
---
ChangeLog | 2 ++
doc/html/pcre2_jit_stack_create.html | 3 ++-
doc/html/pcre2api.html | 4 ++--
doc/html/pcre2test.html | 2 +-
doc/pcre2.txt | 4 ++--
doc/pcre2test.txt | 2 +-
6 files changed, 10 insertions(+), 7 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 1f242b2..8a33cac 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -18,6 +18,8 @@ not supported.
5. Merged patch from @carenas (GitHub #52, b037bfa1) to fix build on GNU Hurd.
+6. Merged documentation and comments patches from @carenas (GitHub #47).
+
Version 10.39 29-October-2021
-----------------------------
diff --git a/doc/html/pcre2_jit_stack_create.html b/doc/html/pcre2_jit_stack_create.html
index 6200d17..548947c 100644
--- a/doc/html/pcre2_jit_stack_create.html
+++ b/doc/html/pcre2_jit_stack_create.html
@@ -34,7 +34,8 @@ allocation. The result can be passed to the JIT run-time code by calling
pcre2_jit_stack_assign() to associate the stack with a compiled pattern,
which can then be processed by pcre2_match() or pcre2_jit_match().
A maximum stack size of 512KiB to 1MiB should be more than enough for any
-pattern. For more details, see the
+pattern. If the stack couldn't be allocated or the values passed were not
+reasonable, NULL will be returned. For more details, see the
pcre2jit
page.
diff --git a/doc/html/pcre2api.html b/doc/html/pcre2api.html
index 0c97996..44158f8 100644
--- a/doc/html/pcre2api.html
+++ b/doc/html/pcre2api.html
@@ -1845,7 +1845,7 @@ undefined. It may cause your program to crash or loop.
Note that this option can also be passed to pcre2_match() and
-pcre_dfa_match(), to suppress UTF validity checking of the subject
+pcre2_dfa_match(), to suppress UTF validity checking of the subject
string.
@@ -3850,7 +3850,7 @@ Here is an example of a simple call to pcre2_dfa_match():
-Option bits for pcre_dfa_match()
+Option bits for pcre2_dfa_match()
The unused bits of the options argument for pcre2_dfa_match() must
diff --git a/doc/html/pcre2test.html b/doc/html/pcre2test.html
index 3ee51cd..8b6d35d 100644
--- a/doc/html/pcre2test.html
+++ b/doc/html/pcre2test.html
@@ -78,7 +78,7 @@ to 8-bit code units for output.
In the rest of this document, the names of library functions and structures
-are given in generic form, for example, pcre_compile(). The actual
+are given in generic form, for example, pcre2_compile(). The actual
names used in the libraries have a suffix _8, _16, or _32, as appropriate.
INPUT ENCODING
diff --git a/doc/pcre2.txt b/doc/pcre2.txt
index 0b1b876..105762e 100644
--- a/doc/pcre2.txt
+++ b/doc/pcre2.txt
@@ -1815,7 +1815,7 @@ COMPILING A PATTERN
to crash or loop.
Note that this option can also be passed to pcre2_match() and
- pcre_dfa_match(), to suppress UTF validity checking of the subject
+ pcre2_dfa_match(), to suppress UTF validity checking of the subject
string.
Note also that setting PCRE2_NO_UTF_CHECK at compile time does not dis-
@@ -3698,7 +3698,7 @@ MATCHING A PATTERN: THE ALTERNATIVE FUNCTION
wspace, /* working space vector */
20); /* number of elements (NOT size in bytes) */
- Option bits for pcre_dfa_match()
+ Option bits for pcre2_dfa_match()
The unused bits of the options argument for pcre2_dfa_match() must be
zero. The only bits that may be set are PCRE2_ANCHORED,
diff --git a/doc/pcre2test.txt b/doc/pcre2test.txt
index 217bed5..8db3f10 100644
--- a/doc/pcre2test.txt
+++ b/doc/pcre2test.txt
@@ -44,7 +44,7 @@ PCRE2's 8-BIT, 16-BIT AND 32-BIT LIBRARIES
output.
In the rest of this document, the names of library functions and struc-
- tures are given in generic form, for example, pcre_compile(). The ac-
+ tures are given in generic form, for example, pcre2_compile(). The ac-
tual names used in the libraries have a suffix _8, _16, or _32, as ap-
propriate.