summaryrefslogtreecommitdiff
path: root/utf8.c
diff options
context:
space:
mode:
authorKarl Williamson <public@khwilliamson.com>2012-03-20 09:25:09 -0600
committerKarl Williamson <public@khwilliamson.com>2012-03-30 21:40:35 -0600
commit39e518fd0507d74dbc0c77604a10ed01af505ee5 (patch)
tree16fcee720ce78af46646d386a0ddd9ff1f4f825e /utf8.c
parent6bd1c396b29a11ce2a73ba5ea88ab2e86cca27b6 (diff)
downloadperl-39e518fd0507d74dbc0c77604a10ed01af505ee5.tar.gz
utf8.c: Add back inadvertently deleted pod text
This was deleted by mistake in commit 4b88fb76efce8c436e63b907c9842345d4fa77c7
Diffstat (limited to 'utf8.c')
-rw-r--r--utf8.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/utf8.c b/utf8.c
index c8dff984da..613f10a292 100644
--- a/utf8.c
+++ b/utf8.c
@@ -909,6 +909,9 @@ Returns the Unicode code point of the first character in the string C<s>
which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
length, in bytes, of that character.
+This function should only be used when the returned UV is considered
+an index into the Unicode semantic tables (e.g. swashes).
+
Some, but not all, UTF-8 malformations are detected, and in fact, some
malformed input could cause reading beyond the end of the input buffer, which
is why this function is deprecated. Use L</utf8_to_uvuni_buf> instead.