iconv, iconv_open: Improve documentation.
authorBruno Haible <bruno@clisp.org>
Sun, 3 Jan 2021 19:46:04 +0000 (20:46 +0100)
committerBruno Haible <bruno@clisp.org>
Sun, 3 Jan 2021 19:47:42 +0000 (20:47 +0100)
Reported by Noah Misch <noah@leadboat.com> in
<https://lists.gnu.org/archive/html/bug-gnulib/2020-12/msg00172.html>.

* doc/posix-functions/iconv_open.texi: Add new paragraph "Portability
problems handled by Gnulib".
* doc/posix-functions/iconv.texi: Likewise. Update info about AIX.
* m4/iconv.m4 (AM_ICONV_LINK): Improve comments.

ChangeLog
doc/posix-functions/iconv.texi
doc/posix-functions/iconv_open.texi
m4/iconv.m4

index 4b9f08334cd056e4e65f639218b10bf48455b267..6c042f56775af765d621cf6e1acc1b4953f94279 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2021-01-03  Bruno Haible  <bruno@clisp.org>
+
+       iconv, iconv_open: Improve documentation.
+       Reported by Noah Misch <noah@leadboat.com> in
+       <https://lists.gnu.org/archive/html/bug-gnulib/2020-12/msg00172.html>.
+       * doc/posix-functions/iconv_open.texi: Add new paragraph "Portability
+       problems handled by Gnulib".
+       * doc/posix-functions/iconv.texi: Likewise. Update info about AIX.
+       * m4/iconv.m4 (AM_ICONV_LINK): Improve comments.
+
 2021-01-03  Bruno Haible  <bruno@clisp.org>
 
        iconv-h: Fix module description.
index 01e7fd125264844e602af1ac803e04444a11fc48..4e1c182b07cb9822b662b8a6a33b805ff6eb8a4a 100644 (file)
@@ -10,9 +10,15 @@ Portability problems fixed by Gnulib:
 @itemize
 @item
 GNU libiconv is not found if installed in @file{$PREFIX/lib}.
+@end itemize
+
+Portability problems handled by Gnulib
+(in the sense that @code{HAVE_ICONV} does not get defined if the system's
+@code{iconv} function has this problem):
+@itemize
 @item
 Failures are not distinguishable from successful returns on some platforms:
-AIX 5.1, Solaris 10.
+AIX 5.1..7.2, Solaris 10.
 @item
 A buffer overrun can occur on some platforms:
 AIX 6.1..7.1.
index f46cf98bf26ed0ee135d0d8535c4f8a04d8de3f5..98f22ae19a587f8705f58daa3ddbe3b89ef7d4c8 100644 (file)
@@ -10,6 +10,12 @@ Portability problems fixed by either Gnulib module @code{iconv} or @code{iconv_o
 @itemize
 @item
 GNU libiconv is not found if installed in @file{$PREFIX/lib}.
+@end itemize
+
+Portability problems handled by either Gnulib module @code{iconv} or @code{iconv_open}
+(in the sense that @code{HAVE_ICONV} does not get defined if the system's
+@code{iconv_open} function has this problem):
+@itemize
 @item
 No converter from EUC-JP to UTF-8 is provided on some platforms:
 HP-UX 11.
index 04e3bad445118038f73ea4dbed51abc1171008cc..d0e61de2608d79d72ef78f25d98c9bdb3e07f777 100644 (file)
@@ -1,4 +1,4 @@
-# iconv.m4 serial 23
+# iconv.m4 serial 24
 dnl Copyright (C) 2000-2002, 2007-2014, 2016-2021 Free Software Foundation,
 dnl Inc.
 dnl This file is free software; the Free Software Foundation
@@ -92,8 +92,9 @@ AC_DEFUN([AM_ICONV_LINK],
 #endif
              ]],
              [[int result = 0;
-  /* Test against AIX 5.1 bug: Failures are not distinguishable from successful
-     returns.  */
+  /* Test against AIX 5.1...7.2 bug: Failures are not distinguishable from
+     successful returns.  This is even documented in
+     <https://www.ibm.com/support/knowledgecenter/ssw_aix_72/i_bostechref/iconv.html> */
   {
     iconv_t cd_utf8_to_88591 = iconv_open ("ISO8859-1", "UTF-8");
     if (cd_utf8_to_88591 != (iconv_t)(-1))