summaryrefslogtreecommitdiff
path: root/perlvars.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2014-06-17 18:49:53 -0600
committerKarl Williamson <khw@cpan.org>2015-09-30 20:38:47 -0600
commit5a4fed095144d9c2f728401b3a0938f80aca4bcc (patch)
tree26675e7c791b1d061173e6837cc8d6a2f48f9f4f /perlvars.h
parent00bc5c85cfc813f9f8240bc9fd298b733f5225bd (diff)
downloadperl-5a4fed095144d9c2f728401b3a0938f80aca4bcc.tar.gz
perlapi: Clarify process of using undocumented globals
One should send email to p5p first to get the go-ahead for documenting and using an undocumented function or global variable.
Diffstat (limited to 'perlvars.h')
-rw-r--r--perlvars.h9
1 files changed, 7 insertions, 2 deletions
diff --git a/perlvars.h b/perlvars.h
index 7bafa40882..86a369e9ba 100644
--- a/perlvars.h
+++ b/perlvars.h
@@ -10,9 +10,14 @@
/*
=head1 Global Variables
-
These variables are global to an entire process. They are shared between
-all interpreters and all threads in a process.
+all interpreters and all threads in a process. Any variables not documented
+here may be changed or removed without notice, so don't use them!
+If you feel you really do need to use an unlisted variable, first send email to
+L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>. It may be that
+someone there will point out a way to accomplish what you need without using an
+internal variable. But if not, you should get a go-ahead to document and then
+use the variable.
=cut
*/