pad.c apidocs: Clarify use of &PL_sv_no
authorFather Chrysostomos <sprout@cpan.org>
Fri, 26 Jul 2013 04:46:22 +0000 (21:46 -0700)
committerFather Chrysostomos <sprout@cpan.org>
Fri, 26 Jul 2013 06:48:03 +0000 (23:48 -0700)
specifically with regard to possible future changes.

pad.c

diff --git a/pad.c b/pad.c
index 0bf65cd..6969537 100644 (file)
--- a/pad.c
+++ b/pad.c
@@ -58,7 +58,8 @@ AV which is @_.  Other entries are storage for variables and op targets.
 Iterating over the PADNAMELIST iterates over all possible pad
 items.  Pad slots for targets (SVs_PADTMP) and GVs end up having &PL_sv_no
 "names", while slots for constants have &PL_sv_no "names" (see
-pad_alloc()).
+pad_alloc()).  That &PL_sv_no is used is an implementation detail subject
+to change.  To test for it, use C<PadnamePV(name) && !PadnameLEN(name)>.
 
 Only my/our variable (SvPADMY/PADNAME_isOUR) slots get valid names.
 The rest are op targets/GVs/constants which are statically allocated