Hi Paul,
I noticed that when updating the docs for POSIX 2024 you improved the
documentation for removals from POSIX [1]. Like this:
diff --git a/doc/pastposix-functions/bcmp.texi
b/doc/pastposix-functions/bcmp.texi
index 13906aabd2..00ef702a7a 100644
--- a/doc/pastposix-functions/bcmp.texi
+++ b/doc/pastposix-functions/bcmp.texi
@@ -2,7 +2,8 @@
@section @code{bcmp}
@findex bcmp
-POSIX specification:
@url{https://pubs.opengroup.org/onlinepubs/009695399/functions/bcmp.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification:
@url{https://pubs.opengroup.org/onlinepubs/009695399/functions/bcmp.html}
I've committed this patch doing the same for the rest of the files in
doc/pastposix-functions/*.texi since I think it is helpful.
Are POSIX functions always removed the following release that they are
marked obsolete? Or can obsolete functions be kept for multiple
versions?
Collin
[1] https://lists.gnu.org/archive/html/bug-gnulib/2024-05/msg00389.html
>From d599f5994de061a581bc193d9ee30983b3741b35 Mon Sep 17 00:00:00 2001
From: Collin Funk <[email protected]>
Date: Thu, 27 Jun 2024 20:18:53 -0700
Subject: [PATCH] doc: Improve documentation of previous POSIX functions.
* doc/pastposix-functions/bsd_signal.texi: Document revision that
removed function. Mention the link is the previous version.
* doc/pastposix-functions/getcontext.texi: Likewise.
* doc/pastposix-functions/gethostbyaddr.texi: Likewise.
* doc/pastposix-functions/gethostbyname.texi: Likewise.
* doc/pastposix-functions/h_errno.texi: Likewise.
* doc/pastposix-functions/makecontext.texi: Likewise.
* doc/pastposix-functions/pthread_attr_getstackaddr.texi: Likewise.
* doc/pastposix-functions/pthread_attr_setstackaddr.texi: Likewise.
* doc/pastposix-functions/scalb.texi: Likewise.
* doc/pastposix-functions/setcontext.texi: Likewise.
* doc/pastposix-functions/swapcontext.texi: Likewise.
* doc/pastposix-functions/ualarm.texi: Likewise.
* doc/pastposix-functions/usleep.texi: Likewise.
* doc/pastposix-functions/vfork.texi: Likewise.
---
ChangeLog | 19 +++++++++++++++++++
doc/pastposix-functions/bsd_signal.texi | 3 ++-
doc/pastposix-functions/getcontext.texi | 3 ++-
doc/pastposix-functions/gethostbyaddr.texi | 3 ++-
doc/pastposix-functions/gethostbyname.texi | 3 ++-
doc/pastposix-functions/h_errno.texi | 3 ++-
doc/pastposix-functions/makecontext.texi | 3 ++-
.../pthread_attr_getstackaddr.texi | 3 ++-
.../pthread_attr_setstackaddr.texi | 3 ++-
doc/pastposix-functions/scalb.texi | 3 ++-
doc/pastposix-functions/setcontext.texi | 3 ++-
doc/pastposix-functions/swapcontext.texi | 3 ++-
doc/pastposix-functions/ualarm.texi | 3 ++-
doc/pastposix-functions/usleep.texi | 3 ++-
doc/pastposix-functions/vfork.texi | 3 ++-
15 files changed, 47 insertions(+), 14 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 18f538758b..8d65ce6364 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,22 @@
+2024-06-27 Collin Funk <[email protected]>
+
+ doc: Improve documentation of previous POSIX functions.
+ * doc/pastposix-functions/bsd_signal.texi: Document revision that
+ removed function. Mention the link is the previous version.
+ * doc/pastposix-functions/getcontext.texi: Likewise.
+ * doc/pastposix-functions/gethostbyaddr.texi: Likewise.
+ * doc/pastposix-functions/gethostbyname.texi: Likewise.
+ * doc/pastposix-functions/h_errno.texi: Likewise.
+ * doc/pastposix-functions/makecontext.texi: Likewise.
+ * doc/pastposix-functions/pthread_attr_getstackaddr.texi: Likewise.
+ * doc/pastposix-functions/pthread_attr_setstackaddr.texi: Likewise.
+ * doc/pastposix-functions/scalb.texi: Likewise.
+ * doc/pastposix-functions/setcontext.texi: Likewise.
+ * doc/pastposix-functions/swapcontext.texi: Likewise.
+ * doc/pastposix-functions/ualarm.texi: Likewise.
+ * doc/pastposix-functions/usleep.texi: Likewise.
+ * doc/pastposix-functions/vfork.texi: Likewise.
+
2024-06-27 Paul Eggert <[email protected]>
nstrftime: always include locale.h
diff --git a/doc/pastposix-functions/bsd_signal.texi b/doc/pastposix-functions/bsd_signal.texi
index cb2328874d..fad9c5c07d 100644
--- a/doc/pastposix-functions/bsd_signal.texi
+++ b/doc/pastposix-functions/bsd_signal.texi
@@ -2,7 +2,8 @@ @node bsd_signal
@section @code{bsd_signal}
@findex bsd_signal
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/bsd_signal.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/bsd_signal.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/getcontext.texi b/doc/pastposix-functions/getcontext.texi
index 2d91ea17b3..47b208487b 100644
--- a/doc/pastposix-functions/getcontext.texi
+++ b/doc/pastposix-functions/getcontext.texi
@@ -2,7 +2,8 @@ @node getcontext
@section @code{getcontext}
@findex getcontext
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/getcontext.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/getcontext.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/gethostbyaddr.texi b/doc/pastposix-functions/gethostbyaddr.texi
index 9e0598d2cd..556bb69c90 100644
--- a/doc/pastposix-functions/gethostbyaddr.texi
+++ b/doc/pastposix-functions/gethostbyaddr.texi
@@ -2,7 +2,8 @@ @node gethostbyaddr
@section @code{gethostbyaddr}
@findex gethostbyaddr
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/gethostbyaddr.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/gethostbyaddr.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/gethostbyname.texi b/doc/pastposix-functions/gethostbyname.texi
index 462e20205a..5f01377b00 100644
--- a/doc/pastposix-functions/gethostbyname.texi
+++ b/doc/pastposix-functions/gethostbyname.texi
@@ -2,7 +2,8 @@ @node gethostbyname
@section @code{gethostbyname}
@findex gethostbyname
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/gethostbyname.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/gethostbyname.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/h_errno.texi b/doc/pastposix-functions/h_errno.texi
index a6cdec52d0..f21faf1fa1 100644
--- a/doc/pastposix-functions/h_errno.texi
+++ b/doc/pastposix-functions/h_errno.texi
@@ -2,7 +2,8 @@ @node h_errno
@section @code{h_errno}
@findex h_errno
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/h_errno.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/h_errno.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/makecontext.texi b/doc/pastposix-functions/makecontext.texi
index 35a7796de4..dfc1b2a9b1 100644
--- a/doc/pastposix-functions/makecontext.texi
+++ b/doc/pastposix-functions/makecontext.texi
@@ -2,7 +2,8 @@ @node makecontext
@section @code{makecontext}
@findex makecontext
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/makecontext.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/makecontext.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/pthread_attr_getstackaddr.texi b/doc/pastposix-functions/pthread_attr_getstackaddr.texi
index 3b3ec03f79..56607e6fde 100644
--- a/doc/pastposix-functions/pthread_attr_getstackaddr.texi
+++ b/doc/pastposix-functions/pthread_attr_getstackaddr.texi
@@ -2,7 +2,8 @@ @node pthread_attr_getstackaddr
@section @code{pthread_attr_getstackaddr}
@findex pthread_attr_getstackaddr
-POSIX specification:@inlinefmt{tex,@*}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification:@inlinefmt{tex,@*}
@url{https://pubs.opengroup.org/onlinepubs/009695399/functions/pthread_attr_getstackaddr.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/pthread_attr_setstackaddr.texi b/doc/pastposix-functions/pthread_attr_setstackaddr.texi
index 0a08099d30..522c394a04 100644
--- a/doc/pastposix-functions/pthread_attr_setstackaddr.texi
+++ b/doc/pastposix-functions/pthread_attr_setstackaddr.texi
@@ -2,7 +2,8 @@ @node pthread_attr_setstackaddr
@section @code{pthread_attr_setstackaddr}
@findex pthread_attr_setstackaddr
-POSIX specification:@inlinefmt{tex,@*}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification:@inlinefmt{tex,@*}
@url{https://pubs.opengroup.org/onlinepubs/009695399/functions/pthread_attr_setstackaddr.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/scalb.texi b/doc/pastposix-functions/scalb.texi
index a4be83dfc3..ffacf684c3 100644
--- a/doc/pastposix-functions/scalb.texi
+++ b/doc/pastposix-functions/scalb.texi
@@ -2,7 +2,8 @@ @node scalb
@section @code{scalb}
@findex scalb
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/scalb.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/scalb.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/setcontext.texi b/doc/pastposix-functions/setcontext.texi
index cbec23a554..57f1279c0a 100644
--- a/doc/pastposix-functions/setcontext.texi
+++ b/doc/pastposix-functions/setcontext.texi
@@ -2,7 +2,8 @@ @node setcontext
@section @code{setcontext}
@findex setcontext
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/setcontext.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/setcontext.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/swapcontext.texi b/doc/pastposix-functions/swapcontext.texi
index 62c14d4587..155c5cedf8 100644
--- a/doc/pastposix-functions/swapcontext.texi
+++ b/doc/pastposix-functions/swapcontext.texi
@@ -2,7 +2,8 @@ @node swapcontext
@section @code{swapcontext}
@findex swapcontext
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/swapcontext.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/swapcontext.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/ualarm.texi b/doc/pastposix-functions/ualarm.texi
index 4d768d30a5..86b15f81a5 100644
--- a/doc/pastposix-functions/ualarm.texi
+++ b/doc/pastposix-functions/ualarm.texi
@@ -2,7 +2,8 @@ @node ualarm
@section @code{ualarm}
@findex ualarm
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/ualarm.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/ualarm.html}
Gnulib module: ---
diff --git a/doc/pastposix-functions/usleep.texi b/doc/pastposix-functions/usleep.texi
index 3de259c4cc..d8bbbe829a 100644
--- a/doc/pastposix-functions/usleep.texi
+++ b/doc/pastposix-functions/usleep.texi
@@ -2,7 +2,8 @@ @node usleep
@section @code{usleep}
@findex usleep
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/usleep.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/usleep.html}
Gnulib module: usleep
diff --git a/doc/pastposix-functions/vfork.texi b/doc/pastposix-functions/vfork.texi
index 7cd6099eb6..9dfa50f86e 100644
--- a/doc/pastposix-functions/vfork.texi
+++ b/doc/pastposix-functions/vfork.texi
@@ -2,7 +2,8 @@ @node vfork
@section @code{vfork}
@findex vfork
-POSIX specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/vfork.html}
+Removed in POSIX.1-2008.
+POSIX.1-2004 specification: @url{https://pubs.opengroup.org/onlinepubs/009695399/functions/vfork.html}
Gnulib module: ---
--
2.45.2
