docs: document recently fixed glibc printf bug

Document it as a known bug, but one where we don't provide a
workaround since programmers are unlikely to hit it in practice.

* doc/posix-functions/fprintf.texi (fprintf): Document it.
* doc/posix-functions/printf.texi (printf): Likewise.
* doc/posix-functions/vfprintf.texi (vfprintf): Likewise.
* doc/posix-functions/vprintf.texi (vprintf): Likewise.

Signed-off-by: Eric Blake <eblake@redhat.com>

diff --git a/ChangeLog b/ChangeLog
index 6ac14e867a58f5d82a978f24648eb2fa21409831..270866e7acf02c277e10a5de3a1c24f4b6349384 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2011-05-24  Eric Blake  <eblake@redhat.com>
 
+       docs: document recently fixed glibc printf bug
+       * doc/posix-functions/fprintf.texi (fprintf): Document it.
+       * doc/posix-functions/printf.texi (printf): Likewise.
+       * doc/posix-functions/vfprintf.texi (vfprintf): Likewise.
+       * doc/posix-functions/vprintf.texi (vprintf): Likewise.
+
        closein-tests: convert to init.sh
        * modules/closein-tests (Files): Add init.sh
        * tests/test-closein.sh Use it.

diff --git a/doc/posix-functions/fprintf.texi b/doc/posix-functions/fprintf.texi
index 04c4c72cae9ad00c4721d6f56ed79b2fbdbe93f6..44bcca3768c1f5d9935ed487ed1cef5743a72c8a 100644 (file)
--- a/doc/posix-functions/fprintf.texi
+++ b/doc/posix-functions/fprintf.texi
@@ -83,4 +83,8 @@ mingw.
 
 Portability problems not fixed by Gnulib:
 @itemize
+@item
+Attempting to write to a read-only stream fails with @code{EOF} but
+does not set the error flag for @code{ferror} on some platforms:
+glibc 2.13.
 @end itemize

diff --git a/doc/posix-functions/printf.texi b/doc/posix-functions/printf.texi
index df7813f6a4ce7e214d9576430a2bb6b90ffe2592..8fc8cb092204e8ead12c0b379f9bf6be292ad0d2 100644 (file)
--- a/doc/posix-functions/printf.texi
+++ b/doc/posix-functions/printf.texi
@@ -83,4 +83,8 @@ mingw.
 
 Portability problems not fixed by Gnulib:
 @itemize
+@item
+Attempting to write to a read-only stream fails with @code{EOF} but
+does not set the error flag for @code{ferror} on some platforms:
+glibc 2.13.
 @end itemize

diff --git a/doc/posix-functions/vfprintf.texi b/doc/posix-functions/vfprintf.texi
index b40a3341672d2605672d1acf8153eefbbdbd5e87..c6fab25ed74f29c63fffae7d227771d32426d5ab 100644 (file)
--- a/doc/posix-functions/vfprintf.texi
+++ b/doc/posix-functions/vfprintf.texi
@@ -83,4 +83,8 @@ mingw.
 
 Portability problems not fixed by Gnulib:
 @itemize
+@item
+Attempting to write to a read-only stream fails with @code{EOF} but
+does not set the error flag for @code{ferror} on some platforms:
+glibc 2.13.
 @end itemize

diff --git a/doc/posix-functions/vprintf.texi b/doc/posix-functions/vprintf.texi
index 342d182c64bdd6f57d9f3f9019fb0d0e78ea96f4..21d4bc60f10c444dcd0cda2c20fa04b61697a7b5 100644 (file)
--- a/doc/posix-functions/vprintf.texi
+++ b/doc/posix-functions/vprintf.texi
@@ -83,4 +83,8 @@ mingw.
 
 Portability problems not fixed by Gnulib:
 @itemize
+@item
+Attempting to write to a read-only stream fails with @code{EOF} but
+does not set the error flag for @code{ferror} on some platforms:
+glibc 2.13.
 @end itemize