[perl #63234] [DOC PATCH] fix some missing parts of IO::Handle pod
authorZsban Ambrus <perlbug-followup@perl.org>
Mon, 16 Feb 2009 11:18:19 +0000 (12:18 +0100)
committerDavid Mitchell <davem@iabyn.com>
Tue, 23 Jun 2009 20:01:02 +0000 (21:01 +0100)
This documents the previously undocumented fcntl and ioctl methods, and
adds a see also to the IO::File module where the documentation refers
to one of its methods.

(cherry picked from commit 2b93ed3263b8b063954e409dedd232e5b362a927)

ext/IO/lib/IO/Handle.pm

index fa49896..989c98a 100644 (file)
@@ -63,9 +63,11 @@ corresponding built-in functions:
 
     $io->close
     $io->eof
+    $io->fcntl( FUNCTION, SCALAR )
     $io->fileno
     $io->format_write( [FORMAT_NAME] )
     $io->getc
+    $io->ioctl( FUNCTION, SCALAR )
     $io->read ( BUF, LEN, [OFFSET] )
     $io->print ( ARGS )
     $io->printf ( FMT, [ARGS] )
@@ -107,7 +109,8 @@ Furthermore, for doing normal I/O you might need these:
 
 C<fdopen> is like an ordinary C<open> except that its first parameter
 is not a filename but rather a file handle name, an IO::Handle object,
-or a file descriptor number.
+or a file descriptor number.  (For the documentation of the C<open>
+method, see L<IO::File>.)
 
 =item $io->opened
 
@@ -265,7 +268,7 @@ use IO ();  # Load the XS module
 require Exporter;
 @ISA = qw(Exporter);
 
-$VERSION = "1.27_01";
+$VERSION = "1.27_02";
 $VERSION = eval $VERSION;
 
 @EXPORT_OK = qw(
@@ -588,14 +591,12 @@ sub format_write {
     }
 }
 
-# XXX undocumented
 sub fcntl {
     @_ == 3 || croak 'usage: $io->fcntl( OP, VALUE );';
     my ($io, $op) = @_;
     return fcntl($io, $op, $_[2]);
 }
 
-# XXX undocumented
 sub ioctl {
     @_ == 3 || croak 'usage: $io->ioctl( OP, VALUE );';
     my ($io, $op) = @_;