From: Gurusamy Sarathy <gsar@cpan.org>
Date: Mon, 15 Feb 1999 00:05:33 +0000 (+0000)
Subject: tweak READ() docs to mention $buffer must be altered by reference
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=889a76e8f1e5631a20f50ddde7021ae552342884;p=p5sagit%2Fp5-mst-13.2.git

tweak READ() docs to mention $buffer must be altered by reference

p4raw-id: //depot/perl@2920
---

diff --git a/pod/perltie.pod b/pod/perltie.pod
index cae0a15..6652658 100644
--- a/pod/perltie.pod
+++ b/pod/perltie.pod
@@ -680,9 +680,12 @@ This method will be called when the handle is read from via the C<read>
 or C<sysread> functions.
 
     sub READ {
-	$r = shift;
-	my($buf,$len,$offset) = @_;
-	print "READ called, \$buf=$buf, \$len=$len, \$offset=$offset";
+	my $self = shift;
+	my $$bufref = \$_[0];
+	my(undef,$len,$offset) = @_;
+	print "READ called, \$buf=$bufref, \$len=$len, \$offset=$offset";
+	# add to $$bufref, set $len to number of characters read
+	$len;
     }
 
 =item READLINE this
@@ -690,7 +693,7 @@ or C<sysread> functions.
 This method will be called when the handle is read from via <HANDLE>.
 The method should return undef when there is no more data.
 
-    sub READLINE { $r = shift; "PRINT called $$r times\n"; }
+    sub READLINE { $r = shift; "READLINE called $$r times\n"; }
 
 =item GETC this