From 09d1d202eabd3ca07faea5c3153cfcf5b93cb76c Mon Sep 17 00:00:00 2001
From: Eric Blake <ebb9@byu.net>
Date: Tue, 23 Sep 2008 06:48:07 -0600
Subject: [PATCH] fopen: document mingw bug on directories

* doc/posix-functions/fopen.texi (fopen): Mention mingw bug for
not allowing a stream visiting a directory, even though reading
from such a stream is not portable.

Signed-off-by: Eric Blake <ebb9@byu.net>
---
 ChangeLog                      | 7 +++++++
 doc/posix-functions/fopen.texi | 6 ++++++
 2 files changed, 13 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 3dfc1c44b7..38dd15e83f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-09-23  Eric Blake  <ebb9@byu.net>
+
+	fopen: document mingw bug on directories
+	* doc/posix-functions/fopen.texi (fopen): Mention mingw bug for
+	not allowing a stream visiting a directory, even though reading
+	from such a stream is not portable.
+
 2008-09-23  Paolo Bonzini  <bonzini@gnu.org>
 
 	* lib/poll.c: Rewrite.
diff --git a/doc/posix-functions/fopen.texi b/doc/posix-functions/fopen.texi
index da6acde58e..442d1b6659 100644
--- a/doc/posix-functions/fopen.texi
+++ b/doc/posix-functions/fopen.texi
@@ -26,4 +26,10 @@ upon failure.
 On Windows, this function returns a file stream in ``text'' mode by default;
 this means that it translates @code{'\n'} to CR/LF by default.  Use the
 @code{"b"} flag if you need reliable binary I/O.
+@item
+On Windows platforms (excluding Cygwin), this function fails to open
+directories for reading.  Such streams have implementation-defined
+semantics on other platforms.  To avoid directory streams with a
+consistent error message, use @code{fstat} after @code{open} and
+@code{fdopen}, rather than @code{fopen} and @code{fileno}.
 @end itemize
-- 
2.30.2