From: Karl Williamson <khw@khw-desktop.(none)>
Date: Tue, 23 Feb 2010 04:43:35 +0000 (-0700)
Subject: Clarify sv.c API wording.
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=c790c9b676e81d0d100a60ee9760ac29682b5155;p=p5sagit%2Fp5-mst-13.2.git

Clarify sv.c API wording.
---

diff --git a/sv.c b/sv.c
index 0e3c7be..b6c03ed 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)			\