summaryrefslogtreecommitdiff
path: root/utf8.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2018-03-04 10:57:16 -0700
committerKarl Williamson <khw@cpan.org>2018-03-04 11:53:10 -0700
commit07dfe0a4c8603f73b447c48b9b91a04d8fb8962b (patch)
treea50601fd361ef874ac96b8b86244cbcb844feec6 /utf8.c
parent0945d17558ba1cd9ec9357106db73d9b4c0a9009 (diff)
downloadperl-07dfe0a4c8603f73b447c48b9b91a04d8fb8962b.tar.gz
perlapi: utf8_to_uvuni_buf() Add clarification
Diffstat (limited to 'utf8.c')
-rw-r--r--utf8.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/utf8.c b/utf8.c
index a30182a43f..eede51e13b 100644
--- a/utf8.c
+++ b/utf8.c
@@ -2329,7 +2329,9 @@ Perl_utf8_to_uvchr_buf(pTHX_ const U8 *s, const U8 *send, STRLEN *retlen)
Only in very rare circumstances should code need to be dealing in Unicode
(as opposed to native) code points. In those few cases, use
-C<L<NATIVE_TO_UNI(utf8_to_uvchr_buf(...))|/utf8_to_uvchr_buf>> instead.
+C<L<NATIVE_TO_UNI(utf8_to_uvchr_buf(...))|/utf8_to_uvchr_buf>> instead. If you
+are not absolutely sure this is one of those cases, then assume it isn't and
+use plain C<utf8_to_uvchr_buf> instead.
Returns the Unicode (not-native) code point of the first character in the
string C<s> which