changeset 16001:a07c969138fa

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.
author Bruno Haible <bruno@clisp.org>
date Fri, 28 Oct 2011 00:26:55 +0200
parents 79bbea2afc18
children 3ea89d2bf5ad
files ChangeLog doc/posix-functions/fstat.texi doc/posix-functions/opendir.texi doc/posix-functions/readdir.texi doc/posix-functions/rewinddir.texi
diffstat 5 files changed, 25 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
--- 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.
--- a/doc/posix-functions/fstat.texi
+++ b/doc/posix-functions/fstat.texi
@@ -13,8 +13,8 @@
 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:
--- a/doc/posix-functions/opendir.texi
+++ b/doc/posix-functions/opendir.texi
@@ -11,13 +11,13 @@
 @item
 This function is missing on some platforms:
 MSVC 9.
+@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.  (Cf. @code{AC_SYS_LARGEFILE}.)
 @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.
 @end itemize
--- a/doc/posix-functions/readdir.texi
+++ b/doc/posix-functions/readdir.texi
@@ -11,13 +11,13 @@
 @item
 This function is missing on some platforms:
 MSVC 9.
+@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.  (Cf. @code{AC_SYS_LARGEFILE}.)
 @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.
 @end itemize
--- a/doc/posix-functions/rewinddir.texi
+++ b/doc/posix-functions/rewinddir.texi
@@ -11,12 +11,12 @@
 @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