summaryrefslogtreecommitdiff
path: root/pod/perlvar.pod
diff options
context:
space:
mode:
authorZefram <zefram@fysh.org>2011-09-15 22:35:20 +0100
committerZefram <zefram@fysh.org>2011-09-15 22:35:20 +0100
commit09f1e2c2f246fcf3bfa760df58c828d62e6e7954 (patch)
tree7f4ebcf2ca5ca603a5744a48ca05910d7b53b7bb /pod/perlvar.pod
parenta6d4956921ce506c5a81d1e0601c51fb2c84cd4f (diff)
downloadperl-09f1e2c2f246fcf3bfa760df58c828d62e6e7954.tar.gz
document convention for keys in %^H
Diffstat (limited to 'pod/perlvar.pod')
-rw-r--r--pod/perlvar.pod6
1 files changed, 6 insertions, 0 deletions
diff --git a/pod/perlvar.pod b/pod/perlvar.pod
index 3217e3cc55..5708c05f7b 100644
--- a/pod/perlvar.pod
+++ b/pod/perlvar.pod
@@ -603,6 +603,12 @@ X<%^H>
The C<%^H> hash provides the same scoping semantic as C<$^H>. This makes it
useful for implementation of lexically scoped pragmas. See L<perlpragma>.
+When putting items into C<%^H>, in order to avoid conflicting with other
+users of the hash there is a convention regarding which keys to use.
+A module should use only keys that begin with the module's name (the
+name of its main package) and a "/" character. For example, a module
+C<Foo::Bar> should use keys such as C<Foo::Bar/baz>.
+
This variable was added in Perl 5.6.
=item @INC