This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pad.h: Mention ‘fake’ under PadnameOUTER
authorFather Chrysostomos <sprout@cpan.org>
Fri, 28 Nov 2014 06:20:47 +0000 (22:20 -0800)
committerFather Chrysostomos <sprout@cpan.org>
Sun, 30 Nov 2014 19:48:42 +0000 (11:48 -0800)
We refer to ‘fake’ entries in various places in the documentation,
and we still have the word FAKE in PARENT_FAKELEX_FLAGS, so noting
this should be helpful.

pad.h

diff --git a/pad.h b/pad.h
index 5be78c0..135f1d2 100644 (file)
--- a/pad.h
+++ b/pad.h
@@ -246,7 +246,8 @@ Whether this is an "our" variable.
 The stash in which this "our" variable was declared.
 
 =for apidoc m|bool|PadnameOUTER|PADNAME pn
-Whether this entry belongs to an outer pad.
+Whether this entry belongs to an outer pad.  Entries for which this is true
+are often referred to as 'fake'.
 
 =for apidoc m|bool|PadnameIsSTATE|PADNAME pn
 Whether this is a "state" variable.