This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix the API description of SvLEN_set()
authorDavid Mitchell <davem@iabyn.com>
Thu, 3 Dec 2015 10:38:23 +0000 (10:38 +0000)
committerDavid Mitchell <davem@iabyn.com>
Thu, 3 Dec 2015 10:38:23 +0000 (10:38 +0000)
RT #126245

Make it clearer that is the buffer length being specified, not the string
length. Also, change the 'See "SvIV_set"' to SvLEN. That appears to be a
cut and paste error.

Based on suggested wording from jazzkutya@gmail.com

sv.h

diff --git a/sv.h b/sv.h
index 313bfb8..33a0b7b 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -838,7 +838,7 @@ Set the current length of the string which is in the SV.  See C<L</SvCUR>>
 and C<SvIV_set>>.
 
 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
 and C<SvIV_set>>.
 
 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
-Set the actual length of the string which is in the SV.  See C<L</SvIV_set>>.
+Set the size of the string buffer for the SV. See C<L</SvLEN>>.
 
 =cut
 */
 
 =cut
 */