* doc/posix-functions/aligned_alloc.texi:
* doc/posix-functions/posix_memalign.texi: Mention glibc bug
32301, which it is not worth our time to work around.
---
ChangeLog | 5 +++++
doc/posix-functions/aligned_alloc.texi | 5 +++++
doc/posix-functions/posix_memalign.texi | 8 ++++++++
3 files changed, 18 insertions(+)
diff --git a/ChangeLog b/ChangeLog
index ca83d5e14e..9360b71007 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
2024-10-26 Paul Eggert <egg...@cs.ucla.edu>
+ aligned_alloc: document glibc bug 32301
+ * doc/posix-functions/aligned_alloc.texi:
+ * doc/posix-functions/posix_memalign.texi: Mention glibc bug
+ 32301, which it is not worth our time to work around.
+
eealloc: update commentary
Even if we remove eealloc we might as well add commentary
explaining some of its confusion, before we remove it.
diff --git a/doc/posix-functions/aligned_alloc.texi
b/doc/posix-functions/aligned_alloc.texi
index 5c100aff34..4b173760e3 100644
--- a/doc/posix-functions/aligned_alloc.texi
+++ b/doc/posix-functions/aligned_alloc.texi
@@ -25,6 +25,11 @@ On some platforms, @code{aligned_alloc} crashes if the
requested size is
not a multiple of the alignment:
AddressSanitizer (gcc 11.2 or clang 13).
+@item
+If the alignment and size are absurdly large, this function crashes:
+@c https://sourceware.org/bugzilla/show_bug.cgi?id=32301
+glibc 2.40.
+
@item
This function is missing on many older platforms:
glibc 2.15, macOS 10.14, FreeBSD 6.4, NetBSD 7.1, OpenBSD 6.0, Minix 3.1.8,
AIX 7.1, HP-UX 11.31, Solaris 11.3, Cygwin 1.7.x, mingw, MSVC 14, Android 8.1.
diff --git a/doc/posix-functions/posix_memalign.texi
b/doc/posix-functions/posix_memalign.texi
index f70f840efd..585299999a 100644
--- a/doc/posix-functions/posix_memalign.texi
+++ b/doc/posix-functions/posix_memalign.texi
@@ -6,6 +6,10 @@ POSIX specification:@*
@url{https://pubs.opengroup.org/onlinepubs/9799919799/fun
Gnulib module: posix_memalign
+Although this function is superseded by @code{aligned_alloc},
+it is more portable to older systems that do not support C11.
+@xref{aligned_alloc}.
+
Portability problems fixed by Gnulib:
@itemize
@item
@@ -18,6 +22,10 @@ Portability problems not fixed by Gnulib:
@item
This function is missing on some platforms:
Mac OS X 10.5, FreeBSD 6.0, NetBSD 3.0, OpenBSD 3.8, Minix 3.1.8, AIX 5.1,
HP-UX 11, Solaris 10, Cygwin 1.5.x, mingw, MSVC 14, Android 4.1.
+@item
+If the alignment and size are absurdly large, this function crashes:
+@c https://sourceware.org/bugzilla/show_bug.cgi?id=32301
+glibc 2.40.
@end itemize
The Gnulib module @code{aligned-malloc} provides functions for
--
2.43.0
