This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fill out sv_upgrade docs
authorFather Chrysostomos <sprout@cpan.org>
Fri, 4 Nov 2011 15:35:40 +0000 (08:35 -0700)
committerFather Chrysostomos <sprout@cpan.org>
Fri, 4 Nov 2011 20:25:43 +0000 (13:25 -0700)
See commit 5a0c33f0f.

sv.c

diff --git a/sv.c b/sv.c
index 6322c25..1a8c029 100644 (file)
--- a/sv.c
+++ b/sv.c
@@ -1127,7 +1127,10 @@ static const struct body_details fake_rv =
 
 Upgrade an SV to a more complex form.  Generally adds a new body type to the
 SV, then copies across as much information as possible from the old body.
-You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
+It croaks if the SV is already in a more complex form than requested.  You
+generally want to use the C<SvUPGRADE> macro wrapper, which checks the type
+before calling C<sv_upgrade>, and hence does not croak.  See also
+C<svtype>.
 
 =cut
 */