diff options
| author | Karl Williamson <khw@cpan.org> | 2014-06-17 18:49:53 -0600 |
|---|---|---|
| committer | Karl Williamson <khw@cpan.org> | 2015-09-30 20:38:47 -0600 |
| commit | 5a4fed095144d9c2f728401b3a0938f80aca4bcc (patch) | |
| tree | 26675e7c791b1d061173e6837cc8d6a2f48f9f4f | |
| parent | 00bc5c85cfc813f9f8240bc9fd298b733f5225bd (diff) | |
| download | perl-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.
| -rw-r--r-- | autodoc.pl | 13 | ||||
| -rw-r--r-- | perlvars.h | 9 |
2 files changed, 15 insertions, 7 deletions
diff --git a/autodoc.pl b/autodoc.pl index b27fc4d157..4a55c3cf20 100644 --- a/autodoc.pl +++ b/autodoc.pl @@ -304,11 +304,14 @@ interfaces are subject to change. Functions that are not listed in this document are not intended for public use, and should NOT be used under any circumstances. -If you use one of the undocumented functions below, you may wish to consider -creating and submitting documentation -for it. If your patch is accepted, this -will indicate that the interface is stable (unless it is explicitly marked -otherwise). +If you feel you need to use one of these functions, first send email to +L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>. It may be +that there is a good reason for the function not being documented, and it +should be removed from this list; or it may just be that no one has gotten +around to documenting it. In the latter case, you will be asked to submit a +patch to document the function. Once your patch is accepted, it will indicate +that the interface is stable (unless it is explicitly marked otherwise) and +usable by you. =over 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 */ |