From 1bd52e437c60e7ae09145d8a2895abe588cd9e15 Mon Sep 17 00:00:00 2001 From: Bruno Haible Date: Fri, 28 Oct 2011 00:26:55 +0200 Subject: [PATCH] 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. --- ChangeLog | 9 +++++++++ doc/posix-functions/fstat.texi | 4 ++-- doc/posix-functions/opendir.texi | 10 +++++----- doc/posix-functions/readdir.texi | 10 +++++----- doc/posix-functions/rewinddir.texi | 8 ++++---- 5 files changed, 25 insertions(+), 16 deletions(-) diff --git a/ChangeLog b/ChangeLog index 8b2da4fe6b..09c327fac5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2011-10-27 Bruno Haible + + 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 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 acd0296de3..31b4365de0 100644 --- 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 661790cc49..bb9affa981 100644 --- 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 a69b06843a..a17f30c5b6 100644 --- 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 47f8d4c029..6d7cb82d83 100644 --- 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 -- 2.39.5