This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document the explicit * in tie *$handle
authorFather Chrysostomos <sprout@cpan.org>
Fri, 3 Dec 2010 02:02:06 +0000 (18:02 -0800)
committerFather Chrysostomos <sprout@cpan.org>
Fri, 3 Dec 2010 02:02:06 +0000 (18:02 -0800)
pod/perltie.pod

index 791753d..d23c667 100644 (file)
@@ -869,6 +869,13 @@ All of this is especially useful when perl is embedded in some other
 program, where output to STDOUT and STDERR may have to be redirected 
 in some special way.  See nvi and the Apache module for examples.
 
+When tying a handle, the first argument to C<tie> should begin with an
+asterisk. So, if you are tying STDOUT, use C<*STDOUT>. If you have assigned
+it to a scalar variable, say C<$handle>, use C<*$handle>. C<tie $handle>
+works, too, but that is considered a bug and will be fixed in Perl 5.16. It
+is supposed to tie the scalar C<$handle>, not the handle inside it.
+C<tie $handle> emits a deprecation warning as of Perl 5.14.
+
 In our example we're going to create a shouting handle.
 
     package Shout;