Re: doc: Mention backtrace functions supported on BSD.

[Bruno Haible]

Hi Collin,

> FreeBSD, NetBSD, and OpenBSD support backtrace, backtrace_symbols, and
> backtrace_symbols_fd except they use 'size_t' for the second argument [1].
> 
> The man pages seem to agree that FreeBSD gained support in version
> 10.0 [1]. NetBSD and OpenBSD both gained support in version 7.0 [2] [3].

Thanks.

To complement your search, I use the git repo (FreeBSD) or CVS repo (NetBSD,
OpenBSD). My findings agree with yours:

FreeBSD  src/contrib/libexecinfo/execinfo.h
         added on 2013-08-23
         https://en.wikipedia.org/wiki/FreeBSD_version_history
         present in 10.0.0, missing in 9.3.0

NetBSD   src/lib/libexecinfo/execinfo.h
         added on 2012-05-27
         https://en.wikipedia.org/wiki/NetBSD#Releases 
http://www.netbsd.org/releases/formal.html
         present in 7.0, missing in 6.1

OpenBSD  src/gnu/lib/libexecinfo/execinfo.h
         added on 2021-06-09
         https://en.wikipedia.org/wiki/OpenBSD#Releases
         present in 7.0, missing in 6.9

In the documentation, if a function was added in a certain OS release, we still
mention it as missing in the previous OS release, because the goal of the
documentation is to tell the user what to expect. And it's the user who decides
whether portability to OpenBSD version 6.9 is relevant for them, not us.
Also I still have VMs for FreeBSD 5 and OpenBSD 6.x, and if the behaviour
on these VMs is different than on the newest versions, I want to know why.

Also, together with these functions comes a header file, <execinfo.h>, which
we document in doc/glibc-headers/execinfo.texi.


2024-05-11  Bruno Haible  <bruno@clisp.org>

        doc: Update regarding backtrace functions on *BSD.
        * doc/glibc-functions/backtrace.texi: Mention in which *BSD releases
        this function was missing.
        * doc/glibc-functions/backtrace_symbols.texi: Likewise.
        * doc/glibc-functions/backtrace_symbols_fd.texi: LIkewise.
        * doc/glibc-headers/execinfo.texi: Update *BSD versions.

diff --git a/doc/glibc-functions/backtrace.texi 
b/doc/glibc-functions/backtrace.texi
index c44f077191..d1e8ad6df9 100644
--- a/doc/glibc-functions/backtrace.texi
+++ b/doc/glibc-functions/backtrace.texi
@@ -27,9 +27,9 @@
 @itemize
 @item
 This function is missing on many platforms:
-Minix 3.1.8, AIX 5.1, HP-UX 11, Solaris 10, Cygwin 2.9, mingw, MSVC 14, 
Android API level 32.
+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.
 
 @item
 The second argument is of type @code{size_t}, not @code{int}, on some 
platforms:
-FreeBSD 10.0, NetBSD 7.0, OpenBSD 7.0.
+FreeBSD, NetBSD, OpenBSD.
 @end itemize
diff --git a/doc/glibc-functions/backtrace_symbols.texi 
b/doc/glibc-functions/backtrace_symbols.texi
index 65903b9da0..f55730f6c2 100644
--- a/doc/glibc-functions/backtrace_symbols.texi
+++ b/doc/glibc-functions/backtrace_symbols.texi
@@ -27,9 +27,9 @@
 @itemize
 @item
 This function is missing on many platforms:
-Minix 3.1.8, AIX 5.1, HP-UX 11, Solaris 10, Cygwin 2.9, mingw, MSVC 14, 
Android API level 32.
+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.
 
 @item
 The second argument is of type @code{size_t}, not @code{int}, on some 
platforms:
-FreeBSD 10.0, NetBSD 7.0, OpenBSD 7.0.
+FreeBSD, NetBSD, OpenBSD.
 @end itemize
diff --git a/doc/glibc-functions/backtrace_symbols_fd.texi 
b/doc/glibc-functions/backtrace_symbols_fd.texi
index 30ce4a2a06..1240837d43 100644
--- a/doc/glibc-functions/backtrace_symbols_fd.texi
+++ b/doc/glibc-functions/backtrace_symbols_fd.texi
@@ -27,9 +27,9 @@
 @itemize
 @item
 This function is missing on many platforms:
-Minix 3.1.8, AIX 5.1, HP-UX 11, Solaris 10, Cygwin 2.9, mingw, MSVC 14, 
Android API level 32.
+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.
 
 @item
 The second argument is of type @code{size_t}, not @code{int}, on some 
platforms:
-FreeBSD 10.0, NetBSD 7.0, OpenBSD 7.0.
+FreeBSD, NetBSD, OpenBSD.
 @end itemize
diff --git a/doc/glibc-headers/execinfo.texi b/doc/glibc-headers/execinfo.texi
index ea25e562e9..7589b2cc18 100644
--- a/doc/glibc-headers/execinfo.texi
+++ b/doc/glibc-headers/execinfo.texi
@@ -23,7 +23,7 @@
 @itemize
 @item
 This header file is missing on some platforms:
-FreeBSD 6.0, NetBSD 5.0, OpenBSD 6.7, Minix 3.1.8, AIX 5.1, HP-UX 11, Solaris 
10, Cygwin, mingw, MSVC 14, Android 9.0.
+FreeBSD 9.3, NetBSD 6.1, OpenBSD 6.9, Minix 3.1.8, AIX 5.1, HP-UX 11, Solaris 
10, Cygwin, mingw, MSVC 14, Android 9.0.
 @end itemize
 
 Portability problems not fixed by Gnulib: