This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Fix misstatement
authorKarl Williamson <public@khwilliamson.com>
Mon, 24 Dec 2012 15:39:58 +0000 (08:39 -0700)
committerKarl Williamson <public@khwilliamson.com>
Mon, 24 Dec 2012 16:13:07 +0000 (09:13 -0700)
According to the comments for Perl_sv_setuv(), for performance reasons,
a UV that fits in an IV is stored as an IV.

sv.h

diff --git a/sv.h b/sv.h
index b841464..f01a91c 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -655,10 +655,12 @@ Tells an SV that it is an integer and disables all other OK bits.
 Tells an SV that it is an unsigned integer and disables all other OK bits.
 
 =for apidoc Am|bool|SvIOK_UV|SV* sv
 Tells an SV that it is an unsigned integer and disables all other OK bits.
 
 =for apidoc Am|bool|SvIOK_UV|SV* sv
-Returns a boolean indicating whether the SV contains an unsigned integer.
+Returns a boolean indicating whether the SV contains an unsigned integer
+that is too large to store as an IV.
 
 =for apidoc Am|bool|SvUOK|SV* sv
 
 =for apidoc Am|bool|SvUOK|SV* sv
-Returns a boolean indicating whether the SV contains an unsigned integer.
+Returns a boolean indicating whether the SV contains an unsigned integer
+that is too large to store as an IV.
 
 =for apidoc Am|bool|SvIOK_notUV|SV* sv
 Returns a boolean indicating whether the SV contains a signed integer.
 
 =for apidoc Am|bool|SvIOK_notUV|SV* sv
 Returns a boolean indicating whether the SV contains a signed integer.