summaryrefslogtreecommitdiff
path: root/intrpvar.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-11-25 06:54:37 -0700
committerKarl Williamson <khw@cpan.org>2020-11-25 06:59:58 -0700
commit24d9bd5f3ce52745f522f236cc2301e7b8b2e8a2 (patch)
tree71386c7750eda417fc1d8f5a4ececf37c59ae355 /intrpvar.h
parent36f453d19563f9476d4310b8310ce4080209b04f (diff)
downloadperl-24d9bd5f3ce52745f522f236cc2301e7b8b2e8a2.tar.gz
perlapi: PL_sv_yes and kin are read-only
Diffstat (limited to 'intrpvar.h')
-rw-r--r--intrpvar.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/intrpvar.h b/intrpvar.h
index 67ff94ce2f..b11607bc79 100644
--- a/intrpvar.h
+++ b/intrpvar.h
@@ -186,15 +186,16 @@ PERLVAR(I, comppad, PAD *) /* storage for lexically scoped temporaries */
/*
=for apidoc_section $SV
=for apidoc Amn|SV|PL_sv_undef
-This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
+This is the C<undef> SV. It is readonly. Always refer to this as
+C<&PL_sv_undef>.
=for apidoc Amn|SV|PL_sv_no
-This is the C<false> SV. See C<L</PL_sv_yes>>. Always refer to this as
-C<&PL_sv_no>.
+This is the C<false> SV. It is readonly. See C<L</PL_sv_yes>>. Always refer
+to this as C<&PL_sv_no>.
=for apidoc Amn|SV|PL_sv_yes
-This is the C<true> SV. See C<L</PL_sv_no>>. Always refer to this as
-C<&PL_sv_yes>.
+This is the C<true> SV. It is readonly. See C<L</PL_sv_no>>. Always refer to
+this as C<&PL_sv_yes>.
=for apidoc Amn|SV|PL_sv_zero
This readonly SV has a zero numeric value and a C<"0"> string value. It's