This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix doc about filter subroutines' $_[0]
authorZefram <zefram@fysh.org>
Tue, 12 Dec 2017 03:53:33 +0000 (03:53 +0000)
committerZefram <zefram@fysh.org>
Tue, 12 Dec 2017 03:53:33 +0000 (03:53 +0000)
Filter subroutines established by an @INC callback have always received
a numeric zero as their first argument, not a referencet to the sub
as documented.  Fixes [perl #115754].

pod/perlfunc.pod

index 8e3a907..0cf5031 100644 (file)
@@ -6507,11 +6507,12 @@ subroutine will be called to act as a simple source filter, with the
 line as read in L<C<$_>|perlvar/$_>.
 Again, return 1 for each valid line, and 0 after all lines have been
 returned.
+For historical reasons the subroutine will receive a meaningless argument
+(in fact always the numeric value zero) as C<$_[0]>.
 
 =item 4
 
-Optional state for the subroutine.  The state is passed in as C<$_[1]>.  A
-reference to the subroutine itself is passed in as C<$_[0]>.
+Optional state for the subroutine.  The state is passed in as C<$_[1]>.
 
 =back