From: Father Chrysostomos <sprout@cpan.org>
Date: Tue, 22 Feb 2011 20:57:00 +0000 (-0800)
Subject: perlfunc/fileno: Document the -1 retval
X-Git-Tag: accepted/trunk/20130322.191538~5342
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a7c1632ddd60f69c0d947987c4c8a59f2cd23e63;p=platform%2Fupstream%2Fperl.git

perlfunc/fileno: Document the -1 retval
---

diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod
index 149c44b..891d938 100644
--- a/pod/perlfunc.pod
+++ b/pod/perlfunc.pod
@@ -1938,7 +1938,11 @@ on your own, though.
 X<fileno>
 
 Returns the file descriptor for a filehandle, or undefined if the
-filehandle is not open.  This is mainly useful for constructing
+filehandle is not open.  If there is no real file descriptor at the OS
+level, as can happen with filehandles connected to memory objects via
+C<open> with a reference for the third argument, -1 is returned.
+
+This is mainly useful for constructing
 bitmaps for C<select> and low-level POSIX tty-handling operations.
 If FILEHANDLE is an expression, the value is taken as an indirect
 filehandle, generally its name.
@@ -1950,10 +1954,6 @@ same underlying descriptor:
         print "THIS and THAT are dups\n";
     }
 
-(Filehandles connected to memory objects via new features of C<open> may
-return undefined even though they are open.)
-
-
 =item flock FILEHANDLE,OPERATION
 X<flock> X<lock> X<locking>