This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
More nits in perlpragma, and remove the warning about %^H being
authorRafael Garcia-Suarez <rgarciasuarez@gmail.com>
Mon, 22 May 2006 13:47:19 +0000 (13:47 +0000)
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>
Mon, 22 May 2006 13:47:19 +0000 (13:47 +0000)
strictly internal in perlvar.

p4raw-id: //depot/perl@28271

pod/perlpragma.pod
pod/perlvar.pod

index 9c4fd2b..3bdf8b7 100644 (file)
@@ -115,12 +115,14 @@ and C<no myint;> is
 Hence the C<import> and C<unimport> routines are called at B<compile time>
 for the user's code.
 
-User pragmata store their state by writing to C<%^H>, hence these two
-routines manipulate C<%^H>. The state information in C<%^H> is stored in the
-optree, and can be retrieved at runtime with C<caller>, at index 10 of the
-list of returned results. In the example pragma, retrieval is encapsulated
-into the routine C<in_effect()>. This uses C<caller(0)> to determine the
-state of C<$^H{myint}> when each line of the user's script was called, and
+User pragmata store their state by writing to the magical hash C<%^H>,
+hence these two routines manipulate it. The state information in C<%^H> is
+stored in the optree, and can be retrieved at runtime with C<caller>, at
+index 10 of the list of returned results. In the example pragma, retrieval
+is encapsulated into the routine C<in_effect()>, which takes as parameter
+the number of call frames to go up to find the value of the pragma in the
+user's script. This uses C<caller()> to determine the value of
+C<$^H{myint}> when each line of the user's script was called, and
 therefore provide the correct semantics in the subroutine implementing the
 overloaded addition.
 
index 8552274..68c8303 100644 (file)
@@ -995,11 +995,8 @@ version of the same lexical pragma:
 
 =item %^H
 
-WARNING: This variable is strictly for internal use only.  Its availability,
-behavior, and contents are subject to change without notice.
-
 The %^H hash provides the same scoping semantic as $^H.  This makes it
-useful for implementation of lexically scoped pragmas.
+useful for implementation of lexically scoped pragmas. See L<perlpragma>.
 
 =item $INPLACE_EDIT