Updating documentation to reflect actual behavior

QFile::seek is supposed to work on Windows CE with FILE* streams. size()
returns 0 on errors and sequential files. Probably on empty files as
well ;-)

Reviewed-by: Olivier Goffart

1 files changed, 11 insertions, 9 deletions

diff --git a/src/corelib/io/qfile.cpp b/src/corelib/io/qfile.cpp
index 4dd6185..c9b2603 100644
--- a/src/corelib/io/qfile.cpp
+++ b/src/corelib/io/qfile.cpp
@@ -1020,14 +1020,15 @@ bool QFile::open(OpenMode mode)
 
     \bold{Warning:}
     \list 1
-        \o If \a fh is \c stdin, \c stdout, or \c stderr, you may not be able
-           to seek(). See QIODevice::isSequential() for more information.
+        \o If \a fh does not refer to a regular file, e.g., it is \c stdin,
+           \c stdout, or \c stderr, you may not be able to seek(). size()
+           returns \c 0 in those cases. See QIODevice::isSequential() for
+           more information.
         \o Since this function opens the file without specifying the file name,
            you cannot use this QFile with a QFileInfo.
     \endlist
 
-    \note For Windows CE you may not be able to call seek() and resize().
-    Also, size() is set to \c 0.
+    \note For Windows CE you may not be able to call resize().
 
     \sa close(), {qmake Variable Reference#CONFIG}{qmake Variable Reference}
 
@@ -1081,7 +1082,7 @@ bool QFile::open(FILE *fh, OpenMode mode)
 /*!
     \overload
 
-    Opens the existing file descripter \a fd in the given \a mode.
+    Opens the existing file descriptor \a fd in the given \a mode.
     Returns true if successful; otherwise returns false.
 
     When a QFile is opened using this function, close() does not
@@ -1092,12 +1093,13 @@ bool QFile::open(FILE *fh, OpenMode mode)
     are slow. If you run into performance issues, you should try to
     use one of the other open functions.
 
-    \warning If \a fd is 0 (\c stdin), 1 (\c stdout), or 2 (\c
-    stderr), you may not be able to seek(). size() is set to \c
-    LLONG_MAX (in \c <climits>).
+    \warning If \a fd is not a regular file, e.g, it is 0 (\c stdin),
+    1 (\c stdout), or 2 (\c stderr), you may not be able to seek(). In
+    those cases, size() returns \c 0.  See QIODevice::isSequential()
+    for more information.
 
     \warning For Windows CE you may not be able to call seek(), setSize(),
-    fileTime(). size() is set to \c 0.
+    fileTime(). size() returns \c 0.
 
     \warning Since this function opens the file without specifying the file name,
              you cannot use this QFile with a QFileInfo.