summaryrefslogtreecommitdiff
path: root/sv.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@khw-desktop.(none)>2010-02-22 21:43:35 -0700
committerJesse Vincent <jesse@bestpractical.com>2010-02-28 10:15:19 -1000
commitc790c9b676e81d0d100a60ee9760ac29682b5155 (patch)
tree881878ff3ef9b338ab26a71666c93da7ffc25653 /sv.c
parenta1f97a07fa8362ead50c8cd62c4ed6bb0066574f (diff)
downloadperl-c790c9b676e81d0d100a60ee9760ac29682b5155.tar.gz
Clarify sv.c API wording.
Diffstat (limited to 'sv.c')
-rw-r--r--sv.c3
1 files changed, 2 insertions, 1 deletions
diff --git a/sv.c b/sv.c
index 0e3c7bec62..b6c03ed7ea 100644
--- a/sv.c
+++ b/sv.c
@@ -7674,7 +7674,8 @@ string. You are responsible for ensuring that the source string is at least
C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
-returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
+returning. If C<SVf_UTF8> is set, C<s> is considered to be in UTF-8 and the
+C<SVf_UTF8> flag will be set on the new SV.
C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
#define newSVpvn_utf8(s, len, u) \