From: Eric Blake <eblake@redhat.com>
Date: Tue, 24 May 2011 23:33:39 +0000 (-0600)
Subject: docs: document recently fixed glibc printf bug
X-Git-Tag: stable/20110609~63
X-Git-Url: http://erislabs.org.uk/gitweb/?a=commitdiff_plain;h=61c4bf636e62c93ea141536d90e5ef06f9b74ad5;p=gnulib.git

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>
(cherry picked from commit f4c4af09bcf3f0497dc3347ecc0a0b3c9ee1ff63)
---

diff --git a/ChangeLog b/ChangeLog
index eee881336..15d64f8d9 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,8 +1,10 @@
 2011-05-24  Eric Blake  <eblake@redhat.com>
 
-	atexit-tests: ensure reliable exit status
-	* tests/test-atexit.sh: Prefer 'Exit' over 'exit'.
-	Reported by Bruno Haible.
+	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.
 
 2011-05-24  Eric Blake  <eblake@redhat.com>
 
diff --git a/doc/posix-functions/fprintf.texi b/doc/posix-functions/fprintf.texi
index 04c4c72ca..44bcca376 100644
--- 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 df7813f6a..8fc8cb092 100644
--- 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 b40a33416..c6fab25ed 100644
--- 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 342d182c6..21d4bc60f 100644
--- 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