summaryrefslogtreecommitdiff
path: root/dist/IO/lib
diff options
context:
space:
mode:
authorDominic Hargreaves <dom@earth.li>2013-04-28 22:11:57 +0100
committerDominic Hargreaves <dom@earth.li>2013-05-07 23:14:11 +0100
commit2e70af16400b46f7e11e307b99df6a0163931c50 (patch)
treea63741d8023faf2394a55a4cfa60ed1470041820 /dist/IO/lib
parente6b54db65c0cdda6ff40959415e828972b6a92b5 (diff)
downloadperl-2e70af16400b46f7e11e307b99df6a0163931c50.tar.gz
[perl #117791] Clarify that write does not match the C 'write' semantics
Diffstat (limited to 'dist/IO/lib')
-rw-r--r--dist/IO/lib/IO/Handle.pm7
1 files changed, 5 insertions, 2 deletions
diff --git a/dist/IO/lib/IO/Handle.pm b/dist/IO/lib/IO/Handle.pm
index 68e6d902e4..3b1e67dd49 100644
--- a/dist/IO/lib/IO/Handle.pm
+++ b/dist/IO/lib/IO/Handle.pm
@@ -139,9 +139,12 @@ guaranteed.
=item $io->write ( BUF, LEN [, OFFSET ] )
-This C<write> is like C<write> found in C, that is it is the
+This C<write> is somewhat like C<write> found in C, in that it is the
opposite of read. The wrapper for the perl C<write> function is
-called C<format_write>.
+called C<format_write>. However, whilst the C C<write> function returns
+the number of bytes written, this C<write> function simply returns true
+if successful (like C<print>). A more C-like C<write> is C<syswrite>
+(see above).
=item $io->error