This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Better POD for newSVrv
authorDaniel Dragan <bulk88@hotmail.com>
Thu, 20 Dec 2012 04:59:19 +0000 (23:59 -0500)
committerSteffen Mueller <smueller@cpan.org>
Thu, 20 Dec 2012 17:53:56 +0000 (18:53 +0100)
commit67e0a0c0fa359c21f10ed71e46ee8ffa17fcf1e9
treed27e9ad319a5307d555b93fccb91300fa179c9de
parentc2219caf03810d2991764f19584d6d80b2d1f905
Better POD for newSVrv

It takes me a couple times to slowly read the description to realize
what this does. The "its reference count is 1" can be misread to mean
someone must mortalize the return value of newSVrv. The "Creates
a new SV for the RV, C<rv>, to point to." can be misread to mean that
newSVrv is a macro, and will do an &() on rv to create a total of
two new SVs. An SvRV pointing to a posssibly blessed undef SV.
This is also wrong. Adding "existing" makes the point that rv
will not be created in this call.
sv.c