git: aa7487ee9537 - stable/14 - queue.3: document STAILQ_REVERSE

From: Konstantin Belousov <kib_at_FreeBSD.org>
Date: Sat, 10 May 2025 19:33:05 UTC
The branch stable/14 has been updated by kib:

URL: https://cgit.FreeBSD.org/src/commit/?id=aa7487ee9537698f25792065fce47acda47081e2

commit aa7487ee9537698f25792065fce47acda47081e2
Author:     Konstantin Belousov <kib@FreeBSD.org>
AuthorDate: 2025-05-04 16:04:09 +0000
Commit:     Konstantin Belousov <kib@FreeBSD.org>
CommitDate: 2025-05-10 18:15:21 +0000

    queue.3: document STAILQ_REVERSE
    
    (cherry picked from commit a5a186baf2c89ebfd795d74d9223d57acd8c0383)
---
 share/man/man3/Makefile | 1 +
 share/man/man3/queue.3  | 6 ++++++
 2 files changed, 7 insertions(+)

diff --git a/share/man/man3/Makefile b/share/man/man3/Makefile
index 9f0c796e445c..5f336b6b7d2a 100644
--- a/share/man/man3/Makefile
+++ b/share/man/man3/Makefile
@@ -261,6 +261,7 @@ MLINKS+=	queue.3 LIST_CLASS_ENTRY.3 \
 		queue.3 STAILQ_REMOVE.3 \
 		queue.3 STAILQ_REMOVE_AFTER.3 \
 		queue.3 STAILQ_REMOVE_HEAD.3 \
+		queue.3 STAILQ_REVERSE.3 \
 		queue.3 STAILQ_SPLIT_AFTER.3 \
 		queue.3 STAILQ_SWAP.3 \
 		queue.3 TAILQ_CLASS_ENTRY.3 \
diff --git a/share/man/man3/queue.3 b/share/man/man3/queue.3
index a43357d9dd13..aef4944e3847 100644
--- a/share/man/man3/queue.3
+++ b/share/man/man3/queue.3
@@ -75,6 +75,7 @@
 .Nm STAILQ_REMOVE ,
 .Nm STAILQ_REMOVE_AFTER ,
 .Nm STAILQ_REMOVE_HEAD ,
+.Nm STAILQ_REVERSE ,
 .Nm STAILQ_SPLIT_AFTER ,
 .Nm STAILQ_SWAP ,
 .Nm LIST_CLASS_ENTRY ,
@@ -179,6 +180,7 @@ lists and tail queues
 .Fn STAILQ_REMOVE "STAILQ_HEAD *head" "TYPE *elm" "TYPE" "STAILQ_ENTRY NAME"
 .Fn STAILQ_REMOVE_AFTER "STAILQ_HEAD *head" "TYPE *elm" "STAILQ_ENTRY NAME"
 .Fn STAILQ_REMOVE_HEAD "STAILQ_HEAD *head" "STAILQ_ENTRY NAME"
+.Fn STAILQ_REVERSE "STAILQ_HEAD *head" "TYPE" "STAILQ_ENTRY NAME"
 .Fn STAILQ_SPLIT_AFTER "STAILQ_HEAD *head" "TYPE *elm" "STAILQ_HEAD *rest" "STAILQ_ENTRY NAME"
 .Fn STAILQ_SWAP "STAILQ_HEAD *head1" "STAILQ_HEAD *head2" "TYPE"
 .\"
@@ -793,6 +795,10 @@ A doubly-linked tail queue should be used if this macro is needed in
 high-usage code paths or to operate on long tail queues.
 .Pp
 The macro
+.Nm STAILQ_REVERSE
+reverses the queue in place.
+.Pp
+The macro
 .Nm STAILQ_SPLIT_AFTER
 splits the tail queue referenced by
 .Fa head ,