From b57937c05283fb674088d54d5a4de3cc72feac1b Mon Sep 17 00:00:00 2001 From: Bruno Haible Date: Fri, 30 Jun 2023 16:24:00 +0200 Subject: [PATCH] doc: Reference some reported bugs (in comments). * doc/posix-functions/mbrlen.texi: Add references to bug reports. * doc/posix-functions/mbrtoc16.texi: Likewise. * doc/posix-functions/mbrtoc32.texi: Likewise. * doc/posix-functions/mbrtowc.texi: Likewise. * doc/posix-functions/mbsnrtowcs.texi: Likewise. * doc/posix-functions/mbsrtowcs.texi: Likewise. * doc/posix-functions/mbstowcs.texi: Likewise. --- ChangeLog | 11 +++++++++++ doc/posix-functions/mbrlen.texi | 2 ++ doc/posix-functions/mbrtoc16.texi | 12 ++++++++++-- doc/posix-functions/mbrtoc32.texi | 12 ++++++++++-- doc/posix-functions/mbrtowc.texi | 6 +++++- doc/posix-functions/mbsnrtowcs.texi | 2 ++ doc/posix-functions/mbsrtowcs.texi | 2 ++ doc/posix-functions/mbstowcs.texi | 2 ++ 8 files changed, 44 insertions(+), 5 deletions(-) diff --git a/ChangeLog b/ChangeLog index 1953ccdd96..5c2ea3039c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,14 @@ +2023-06-30 Bruno Haible + + doc: Reference some reported bugs (in comments). + * doc/posix-functions/mbrlen.texi: Add references to bug reports. + * doc/posix-functions/mbrtoc16.texi: Likewise. + * doc/posix-functions/mbrtoc32.texi: Likewise. + * doc/posix-functions/mbrtowc.texi: Likewise. + * doc/posix-functions/mbsnrtowcs.texi: Likewise. + * doc/posix-functions/mbsrtowcs.texi: Likewise. + * doc/posix-functions/mbstowcs.texi: Likewise. + 2023-06-29 Paul Eggert assert-tests: pacify gcc -Wunused-function diff --git a/doc/posix-functions/mbrlen.texi b/doc/posix-functions/mbrlen.texi index 0c55ddae21..9545d4c16e 100644 --- a/doc/posix-functions/mbrlen.texi +++ b/doc/posix-functions/mbrlen.texi @@ -14,6 +14,8 @@ Minix 3.1.8, HP-UX 11.00, IRIX 6.5, mingw. @item In the C or POSIX locales, this function can return @code{(size_t) -1} and set @code{errno} to @code{EILSEQ}: +@c https://sourceware.org/bugzilla/show_bug.cgi?id=19932 +@c https://sourceware.org/bugzilla/show_bug.cgi?id=29511 glibc 2.35. @item This function returns 0 instead of @code{(size_t) -2} when the input diff --git a/doc/posix-functions/mbrtoc16.texi b/doc/posix-functions/mbrtoc16.texi index ed568d593f..2c483f5170 100644 --- a/doc/posix-functions/mbrtoc16.texi +++ b/doc/posix-functions/mbrtoc16.texi @@ -16,11 +16,16 @@ glibc 2.36. @item In the C or POSIX locales, this function can return @code{(size_t) -1} and set @code{errno} to @code{EILSEQ}: +@c https://sourceware.org/bugzilla/show_bug.cgi?id=19932 +@c https://sourceware.org/bugzilla/show_bug.cgi?id=29511 glibc 2.36. @item This function returns 0 instead of @code{(size_t) -2} when the input is empty: -glibc 2.19, Android 11. +@c https://sourceware.org/bugzilla/show_bug.cgi?id=16950 +glibc 2.19, +@c https://issuetracker.google.com/issues/289419880 +Android 11. @item This function returns the total number of bytes that make up the multibyte character, not the number of bytes that were needed to complete the multibyte @@ -30,11 +35,14 @@ mingw. This function returns @code{(size_t) -3} instead of a byte count when it has stored a high surrogate, and returns a byte count instead of @code{(size_t) -3} when it has stored a low surrogate, on some platforms: +@c https://issuetracker.google.com/issues/289419882 Android. @item This function does not recognize multibyte sequences that @code{mbrtowc} recognizes on some platforms: -FreeBSD 13.2, Solaris 11.4, MSVC 14. +@c https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=272293 +FreeBSD 13.2, +Solaris 11.4, MSVC 14. @c For MSVC this is because it assumes that the input is always UTF-8 encoded. @c See https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/mbrtoc16-mbrtoc323 @end itemize diff --git a/doc/posix-functions/mbrtoc32.texi b/doc/posix-functions/mbrtoc32.texi index 8792a7b11b..db7d6a0821 100644 --- a/doc/posix-functions/mbrtoc32.texi +++ b/doc/posix-functions/mbrtoc32.texi @@ -12,17 +12,25 @@ glibc 2.15, macOS 11.1, FreeBSD 6.4, NetBSD 9.0, OpenBSD 6.7, Minix 3.1.8, AIX 7 @item In the C or POSIX locales, this function can return @code{(size_t) -1} and set @code{errno} to @code{EILSEQ}: +@c https://sourceware.org/bugzilla/show_bug.cgi?id=19932 +@c https://sourceware.org/bugzilla/show_bug.cgi?id=29511 glibc 2.35. @item This function returns 0 instead of @code{(size_t) -2} when the input is empty: -glibc 2.19, mingw, Android 11, +@c https://sourceware.org/bugzilla/show_bug.cgi?id=16950 +glibc 2.19, +mingw, +@c https://issuetracker.google.com/issues/289419880 +Android 11, @c https://dev.haiku-os.org/ticket/18350 Haiku. @item This function does not recognize multibyte sequences that @code{mbrtowc} recognizes on some platforms: -FreeBSD 13.0, Solaris 11.4, mingw, MSVC 14. +@c https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=272293 +FreeBSD 13.2, +Solaris 11.4, mingw, MSVC 14. @c For MSVC this is because it assumes that the input is always UTF-8 encoded. @c See https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/mbrtoc16-mbrtoc323 @end itemize diff --git a/doc/posix-functions/mbrtowc.texi b/doc/posix-functions/mbrtowc.texi index 52471978fc..f61b4806c6 100644 --- a/doc/posix-functions/mbrtowc.texi +++ b/doc/posix-functions/mbrtowc.texi @@ -14,11 +14,15 @@ Minix 3.1.8, HP-UX 11.00, IRIX 6.5, mingw. @item In the C or POSIX locales, this function can return @code{(size_t) -1} and set @code{errno} to @code{EILSEQ}: +@c https://sourceware.org/bugzilla/show_bug.cgi?id=19932 +@c https://sourceware.org/bugzilla/show_bug.cgi?id=29511 glibc 2.35. @item This function returns 0 instead of @code{(size_t) -2} when the input is empty: -glibc 2.19, MSVC 14, Android 11. +@c https://sourceware.org/bugzilla/show_bug.cgi?id=16950 +glibc 2.19, +MSVC 14, Android 11. @item This function returns @code{(size_t) -1} instead of @code{(size_t) -2} when the input is empty: diff --git a/doc/posix-functions/mbsnrtowcs.texi b/doc/posix-functions/mbsnrtowcs.texi index 3a420c673a..ae389b414d 100644 --- a/doc/posix-functions/mbsnrtowcs.texi +++ b/doc/posix-functions/mbsnrtowcs.texi @@ -17,6 +17,8 @@ Solaris 11.4. @item In the C or POSIX locales, this function can return @code{(size_t) -1} and set @code{errno} to @code{EILSEQ}: +@c https://sourceware.org/bugzilla/show_bug.cgi?id=19932 +@c https://sourceware.org/bugzilla/show_bug.cgi?id=29511 glibc 2.35. @end itemize diff --git a/doc/posix-functions/mbsrtowcs.texi b/doc/posix-functions/mbsrtowcs.texi index 28c450ddfb..88da2a06aa 100644 --- a/doc/posix-functions/mbsrtowcs.texi +++ b/doc/posix-functions/mbsrtowcs.texi @@ -17,6 +17,8 @@ HP-UX 11, Solaris 11 2010-11. @item In the C or POSIX locales, this function can return @code{(size_t) -1} and set @code{errno} to @code{EILSEQ}: +@c https://sourceware.org/bugzilla/show_bug.cgi?id=19932 +@c https://sourceware.org/bugzilla/show_bug.cgi?id=29511 glibc 2.35. @item This function does not work when the first argument is NULL on some platforms: diff --git a/doc/posix-functions/mbstowcs.texi b/doc/posix-functions/mbstowcs.texi index a695edc2af..2071219d6c 100644 --- a/doc/posix-functions/mbstowcs.texi +++ b/doc/posix-functions/mbstowcs.texi @@ -11,6 +11,8 @@ Portability problems fixed by Gnulib: @item In the C or POSIX locales, this function can return @code{(size_t) -1} and set @code{errno} to @code{EILSEQ}: +@c https://sourceware.org/bugzilla/show_bug.cgi?id=19932 +@c https://sourceware.org/bugzilla/show_bug.cgi?id=29511 glibc 2.35. @end itemize -- 2.39.5