In doc/glibc-headers/execinfo.texi, the apparent contradiction between
"Gnulib module: ---"
and
"the Gnulib substitute implementation is just a stub"
caught my eye.
2024-05-11 Bruno Haible <br...@clisp.org>
doc: Mention module execinfo.
* doc/glibc-headers/execinfo.texi: Mention module execinfo.
* doc/glibc-functions/backtrace.texi: Likewise.
* doc/glibc-functions/backtrace_symbols.texi: Likewise.
* doc/glibc-functions/backtrace_symbols_fd.texi: LIkewise.
diff --git a/doc/glibc-functions/backtrace.texi
b/doc/glibc-functions/backtrace.texi
index d1e8ad6df9..b9a56094c1 100644
--- a/doc/glibc-functions/backtrace.texi
+++ b/doc/glibc-functions/backtrace.texi
@@ -17,19 +17,21 @@
@uref{https://www.kernel.org/doc/man-pages/online/pages/man3/backtrace.3.html,,man
backtrace}.
@end itemize
-Gnulib module: ---
+Gnulib module: execinfo
Portability problems fixed by Gnulib:
@itemize
-@end itemize
-
-Portability problems not fixed by Gnulib:
-@itemize
@item
This function is missing on many platforms:
FreeBSD 9.3, NetBSD 6.1, OpenBSD 6.9, Minix 3.1.8, AIX 5.1, HP-UX 11, Solaris
10, Cygwin 2.9, mingw, MSVC 14, Android API level 32.
+@end itemize
+Portability problems not fixed by Gnulib:
+@itemize
@item
The second argument is of type @code{size_t}, not @code{int}, on some
platforms:
FreeBSD, NetBSD, OpenBSD.
+@item
+On platforms where the function is missing,
+the Gnulib substitute implementation is just a stub, and does nothing.
@end itemize
diff --git a/doc/glibc-functions/backtrace_symbols.texi
b/doc/glibc-functions/backtrace_symbols.texi
index f55730f6c2..f63e263a81 100644
--- a/doc/glibc-functions/backtrace_symbols.texi
+++ b/doc/glibc-functions/backtrace_symbols.texi
@@ -17,19 +17,21 @@
@uref{https://www.kernel.org/doc/man-pages/online/pages/man3/backtrace_symbols.3.html,,man
backtrace_symbols}.
@end itemize
-Gnulib module: ---
+Gnulib module: execinfo
Portability problems fixed by Gnulib:
@itemize
-@end itemize
-
-Portability problems not fixed by Gnulib:
-@itemize
@item
This function is missing on many platforms:
FreeBSD 9.3, NetBSD 6.1, OpenBSD 6.9, Minix 3.1.8, AIX 5.1, HP-UX 11, Solaris
10, Cygwin 2.9, mingw, MSVC 14, Android API level 32.
+@end itemize
+Portability problems not fixed by Gnulib:
+@itemize
@item
The second argument is of type @code{size_t}, not @code{int}, on some
platforms:
FreeBSD, NetBSD, OpenBSD.
+@item
+On platforms where the function is missing,
+the Gnulib substitute implementation is just a stub, and does nothing.
@end itemize
diff --git a/doc/glibc-functions/backtrace_symbols_fd.texi
b/doc/glibc-functions/backtrace_symbols_fd.texi
index 1240837d43..fe97b44b35 100644
--- a/doc/glibc-functions/backtrace_symbols_fd.texi
+++ b/doc/glibc-functions/backtrace_symbols_fd.texi
@@ -17,19 +17,21 @@
@uref{https://www.kernel.org/doc/man-pages/online/pages/man3/backtrace_symbols_fd.3.html,,man
backtrace_symbols_fd}.
@end itemize
-Gnulib module: ---
+Gnulib module: execinfo
Portability problems fixed by Gnulib:
@itemize
-@end itemize
-
-Portability problems not fixed by Gnulib:
-@itemize
@item
This function is missing on many platforms:
FreeBSD 9.3, NetBSD 6.1, OpenBSD 6.9, Minix 3.1.8, AIX 5.1, HP-UX 11, Solaris
10, Cygwin 2.9, mingw, MSVC 14, Android API level 32.
+@end itemize
+Portability problems not fixed by Gnulib:
+@itemize
@item
The second argument is of type @code{size_t}, not @code{int}, on some
platforms:
FreeBSD, NetBSD, OpenBSD.
+@item
+On platforms where the function is missing,
+the Gnulib substitute implementation is just a stub, and does nothing.
@end itemize
diff --git a/doc/glibc-headers/execinfo.texi b/doc/glibc-headers/execinfo.texi
index 7589b2cc18..bb1372ed51 100644
--- a/doc/glibc-headers/execinfo.texi
+++ b/doc/glibc-headers/execinfo.texi
@@ -17,7 +17,7 @@
@uref{https://www.kernel.org/doc/man-pages/online/pages/man3/backtrace.3.html,,man
backtrace}.
@end itemize
-Gnulib module: ---
+Gnulib module: execinfo
Portability problems fixed by Gnulib:
@itemize
