getopt-posix: No longer guarantee that option processing is resettable.

[gnulib.git] / doc / posix-functions / getopt.texi

diff --git a/doc/posix-functions/getopt.texi b/doc/posix-functions/getopt.texi
index d4d03f0..e9f0881 100644 (file)
--- a/doc/posix-functions/getopt.texi
+++ b/doc/posix-functions/getopt.texi
@@ -2,7 +2,7 @@
 @section @code{getopt}
 @findex getopt
 
-POSIX specification: @url{http://www.opengroup.org/onlinepubs/9699919799/functions/getopt.html}
+POSIX specification:@* @url{http://www.opengroup.org/onlinepubs/9699919799/functions/getopt.html}
 
 Gnulib module: getopt-posix or getopt-gnu
 
@@ -13,13 +13,12 @@ it adds a header file @code{<getopt.h>} and a function @code{getopt_long}.
 Portability problems fixed by either Gnulib module @code{getopt-posix} or @code{getopt-gnu}:
 @itemize
 @item
-The @code{getopt} function keeps some internal state that cannot be explicitly
-reset on some platforms:
-mingw.
+This function is missing on some platforms:
+MSVC 9.
 @item
 The value of @code{optind} after a missing required argument is wrong
 on some platforms:
-MacOS 10.5.
+Mac OS X 10.5, AIX 7.1, mingw.
 @end itemize
 
 Portability problems fixed by Gnulib module @code{getopt-gnu}:
@@ -27,7 +26,11 @@ Portability problems fixed by Gnulib module @code{getopt-gnu}:
 @item
 The function @code{getopt} does not support the @samp{+} flag in the options
 string on some platforms:
-MacOS X 10.5, AIX 5.2, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 10.
+Mac OS X 10.5, AIX 5.2, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 11 2010-11.
+@item
+The function @code{getopt} does not obey the combination of @samp{+}
+and @samp{:} flags in the options string on some platforms:
+glibc 2.11.
 @item
 The function @code{getopt} does not obey the @samp{-} flag in the options
 string when @env{POSIXLY_CORRECT} is set on some platforms:
@@ -35,15 +38,23 @@ Cygwin 1.7.0.
 @item
 The function @code{getopt} does not support options with optional arguments
 on some platforms:
-MacOS X 10.5, OpenBSD 4.0, AIX 5.2, HP-UX 11, IRIX 6.5, OSF/1 5.1,
-Solaris 10, Cygwin 1.5.x.
+Mac OS X 10.5, OpenBSD 4.0, AIX 5.2, HP-UX 11, IRIX 6.5, OSF/1 5.1,
+Solaris 11 2010-11, Cygwin 1.5.x.
 @item
 The function @code{getopt_long} is missing on some platforms:
-AIX 5.1, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 9, Interix 3.5.
+AIX 5.1, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 9, MSVC 9, Interix 3.5.
+@item
+The function @code{getopt_long} does not support abbreviated long options
+where all disambiguations are equivalent on some platforms:
+OpenBSD 5.0.
 @item
 The function @code{getopt_long_only} is missing on some platforms:
-MacOS X 10.3, FreeBSD 5.2.1, NetBSD 3.0, AIX 5.1, HP-UX 11, IRIX 6.5,
-OSF/1 5.1, Solaris 9, mingw, Interix 3.5.
+Mac OS X 10.3, FreeBSD 5.2.1, NetBSD 5.0, AIX 5.1, HP-UX 11, IRIX 6.5,
+OSF/1 5.1, Solaris 9, mingw, MSVC 9, Interix 3.5.
+@item
+This function crashes if the option string includes @code{W;} on some
+platforms:
+glibc 2.14.
 @end itemize
 
 Portability problems not fixed by Gnulib:
@@ -58,10 +69,13 @@ testsuite.
 @item
 The glibc implementation allows a complete reset of the environment,
 including re-checking for @env{POSIXLY_CORRECT}, by setting
-@code{optind} to 0.  Other implementations provide @code{optreset},
+@code{optind} to 0.  Several BSD implementations provide @code{optreset},
 causing a reset by setting it non-zero, although it does not
-necessarily re-read @env{POSIXLY_CORRECT}.
+necessarily re-read @env{POSIXLY_CORRECT}.  Solaris @code{getopt} does
+not support either reset method, but does not maintain state that
+needs the extra level of reset.
 @item
-Mixing a leading @samp{-} or @samp{+} with a leading @samp{:} in the
-optstring argument has inconsistent effects across platforms.
+On some platforms, this function does not set the stream error
+indicator on attempts to write to a read-only stream:
+glibc 2.13, Cygwin 1.7.9.
 @end itemize