This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update pod for SvTRUE, to indicate single param evaluation
authorKarl Williamson <khw@cpan.org>
Sun, 14 Jun 2020 18:26:02 +0000 (12:26 -0600)
committerKarl Williamson <khw@cpan.org>
Sat, 18 Jul 2020 03:44:09 +0000 (21:44 -0600)
5.32 changed this macro into an inline function so that 'sv' only gets
evaluated once, but didn't update the documentation to reflect that.

sv.h

diff --git a/sv.h b/sv.h
index 3721b2f..ad8accb 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -1607,7 +1607,8 @@ false.  See C<L</SvOK>> for a defined/undefined test.  Handles 'get' magic
 unless the scalar is already C<SvPOK>, C<SvIOK> or C<SvNOK> (the public, not the
 private flags).
 
-See C<L</SvTRUEx>> for a version which guarantees to evaluate C<sv> only once.
+As of Perl 5.32, this is guaranteed to evaluate C<sv> only once.  Prior to that
+release, use C<L</SvTRUEx>> for single evaluation.
 
 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
 Returns a boolean indicating whether Perl would evaluate the SV as true or