Update documentation regarding 'largefile' module.

* doc/posix-functions/fstat.texi: Tweak wording.
* doc/posix-functions/opendir.texi: Mention that the module fixes the
problems with huge directories and/or small ino_t types.
* doc/posix-functions/readdir.texi: Likewise.
* doc/posix-functions/rewinddir.texi: Likewise.

diff --git a/ChangeLog b/ChangeLog
index 8b2da4fe6b3df6ca1b8a3a8e3eee3a7f802bcb7b..09c327fac55c1ef3bda7ac4234eccacfd3176d4b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2011-10-27  Bruno Haible  <bruno@clisp.org>
+
+       Update documentation regarding 'largefile' module.
+       * doc/posix-functions/fstat.texi: Tweak wording.
+       * doc/posix-functions/opendir.texi: Mention that the module fixes the
+       problems with huge directories and/or small ino_t types.
+       * doc/posix-functions/readdir.texi: Likewise.
+       * doc/posix-functions/rewinddir.texi: Likewise.
+
 2011-10-28  Gary V. Vaughan  <gary@gnu.org>
 
        maint.mk: don't maintain a second build-aux variable.

diff --git a/doc/posix-functions/fstat.texi b/doc/posix-functions/fstat.texi
index acd0296de30d1959c29c8d2e18006d3b924a786a..31b4365de0c6e4b441e7fcee952168fd836f969b 100644 (file)
--- a/doc/posix-functions/fstat.texi
+++ b/doc/posix-functions/fstat.texi
@@ -13,8 +13,8 @@ This function crashes when invoked with invalid arguments on some platforms:
 MSVC 9.
 @item
 On platforms where @code{off_t} is a 32-bit type, @code{fstat} may not correctly
-report the size of files or block devices larger than 2 GB.  The fix is to
-use the @code{AC_SYS_LARGEFILE} macro.
+report the size of files or block devices larger than 2 GB.
+(Cf. @code{AC_SYS_LARGEFILE}.)
 @end itemize
 
 Portability problems not fixed by Gnulib:

diff --git a/doc/posix-functions/opendir.texi b/doc/posix-functions/opendir.texi
index 661790cc4942afe5b40554e740fe5d00e88de40b..bb9affa9810e6a24cbae84a646faecaee3f7c2ba 100644 (file)
--- a/doc/posix-functions/opendir.texi
+++ b/doc/posix-functions/opendir.texi
@@ -11,13 +11,13 @@ Portability problems fixed by Gnulib:
 @item
 This function is missing on some platforms:
 MSVC 9.
-@end itemize
-
-Portability problems not fixed by Gnulib:
-@itemize
 @item
 On platforms where @code{off_t} is a 32-bit type, this function may not
 work correctly on huge directories larger than 2 GB.  Also, on platforms
 where @code{ino_t} is a 32-bit type, this function may report inode numbers
-incorrectly.  The fix is to use the @code{AC_SYS_LARGEFILE} macro.
+incorrectly.  (Cf. @code{AC_SYS_LARGEFILE}.)
+@end itemize
+
+Portability problems not fixed by Gnulib:
+@itemize
 @end itemize

diff --git a/doc/posix-functions/readdir.texi b/doc/posix-functions/readdir.texi
index a69b06843ad5857a0f2426e77677353fde3c9af3..a17f30c5b66094b9260edb95387d410909086442 100644 (file)
--- a/doc/posix-functions/readdir.texi
+++ b/doc/posix-functions/readdir.texi
@@ -11,13 +11,13 @@ Portability problems fixed by Gnulib:
 @item
 This function is missing on some platforms:
 MSVC 9.
-@end itemize
-
-Portability problems not fixed by Gnulib:
-@itemize
 @item
 On platforms where @code{off_t} is a 32-bit type, this function may not
 work correctly on huge directories larger than 2 GB.  Also, on platforms
 where @code{ino_t} is a 32-bit type, this function may report inode numbers
-incorrectly.  The fix is to use the @code{AC_SYS_LARGEFILE} macro.
+incorrectly.  (Cf. @code{AC_SYS_LARGEFILE}.)
+@end itemize
+
+Portability problems not fixed by Gnulib:
+@itemize
 @end itemize

diff --git a/doc/posix-functions/rewinddir.texi b/doc/posix-functions/rewinddir.texi
index 47f8d4c0294550def91635c3706746b6a6c4e7d2..6d7cb82d832cdac9fc13b7b9e1c7412ff83999ac 100644 (file)
--- a/doc/posix-functions/rewinddir.texi
+++ b/doc/posix-functions/rewinddir.texi
@@ -11,12 +11,12 @@ Portability problems fixed by Gnulib:
 @item
 This function is missing on some platforms:
 MSVC 9.
+@item
+On MacOS X platforms where @code{long int} is a 32-bit type, this function may
+not work correctly on huge directories larger than 2 GB.
+(Cf. @code{AC_SYS_LARGEFILE}.)
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
-@item
-On platforms where @code{long int} is a 32-bit type, this function may not
-work correctly on huge directories larger than 2 GB.  The fix is to use
-the @code{AC_SYS_LARGEFILE} macro (only on MacOS X systems).
 @end itemize