summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authortmm <tmm@FreeBSD.org>2002-04-17 13:48:14 +0000
committertmm <tmm@FreeBSD.org>2002-04-17 13:48:14 +0000
commit2bc2f35287a64134db22c35a92872f32781bbb59 (patch)
treef9fc6adc9b77ba377a029094fbfb18e0414c9d8f /share/man
parentc62faa9e3496b76a85ea9fa61b97daabc90fcbf9 (diff)
downloadFreeBSD-src-2bc2f35287a64134db22c35a92872f32781bbb59.zip
FreeBSD-src-2bc2f35287a64134db22c35a92872f32781bbb59.tar.gz
Document STAILQ_CONCAT and TAILQ_CONCAT.
PR: 20024 Submitted by: Tony Finch <dot@dotat.at> (TAILQ_CONCAT, slightly changed by me) Reviewed by: ru (earlier version)
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man3/Makefile2
-rw-r--r--share/man/man3/queue.324
2 files changed, 26 insertions, 0 deletions
diff --git a/share/man/man3/Makefile b/share/man/man3/Makefile
index 3a41336..2f76c96 100644
--- a/share/man/man3/Makefile
+++ b/share/man/man3/Makefile
@@ -37,6 +37,7 @@ MLINKS+=queue.3 SLIST_INSERT_HEAD.3
MLINKS+=queue.3 SLIST_NEXT.3
MLINKS+=queue.3 SLIST_REMOVE.3
MLINKS+=queue.3 SLIST_REMOVE_HEAD.3
+MLINKS+=queue.3 STAILQ_CONCAT.3
MLINKS+=queue.3 STAILQ_EMPTY.3
MLINKS+=queue.3 STAILQ_ENTRY.3
MLINKS+=queue.3 STAILQ_FIRST.3
@@ -51,6 +52,7 @@ MLINKS+=queue.3 STAILQ_LAST.3
MLINKS+=queue.3 STAILQ_NEXT.3
MLINKS+=queue.3 STAILQ_REMOVE.3
MLINKS+=queue.3 STAILQ_REMOVE_HEAD.3
+MLINKS+=queue.3 TAILQ_CONCAT.3
MLINKS+=queue.3 TAILQ_EMPTY.3
MLINKS+=queue.3 TAILQ_ENTRY.3
MLINKS+=queue.3 TAILQ_FIRST.3
diff --git a/share/man/man3/queue.3 b/share/man/man3/queue.3
index 1a3ad5c..4e80fc1 100644
--- a/share/man/man3/queue.3
+++ b/share/man/man3/queue.3
@@ -48,6 +48,7 @@
.Nm SLIST_NEXT ,
.Nm SLIST_REMOVE_HEAD ,
.Nm SLIST_REMOVE ,
+.Nm STAILQ_CONCAT ,
.Nm STAILQ_EMPTY ,
.Nm STAILQ_ENTRY ,
.Nm STAILQ_FIRST ,
@@ -74,6 +75,7 @@
.Nm LIST_INSERT_HEAD ,
.Nm LIST_NEXT ,
.Nm LIST_REMOVE ,
+.Nm TAILQ_CONCAT ,
.Nm TAILQ_EMPTY ,
.Nm TAILQ_ENTRY ,
.Nm TAILQ_FIRST ,
@@ -108,6 +110,7 @@ lists and tail queues
.Fn SLIST_REMOVE_HEAD "SLIST_HEAD *head" "SLIST_ENTRY NAME"
.Fn SLIST_REMOVE "SLIST_HEAD *head" "TYPE *elm" "TYPE" "SLIST_ENTRY NAME"
.\"
+.Fn STAILQ_CONCAT "STAILQ_HEAD *head1" "STAILQ_HEAD *head2"
.Fn STAILQ_EMPTY "STAILQ_HEAD *head"
.Fn STAILQ_ENTRY "TYPE"
.Fn STAILQ_FIRST "STAILQ_HEAD *head"
@@ -136,6 +139,7 @@ lists and tail queues
.Fn LIST_NEXT "TYPE *elm" "LIST_ENTRY NAME"
.Fn LIST_REMOVE "TYPE *elm" "LIST_ENTRY NAME"
.\"
+.Fn TAILQ_CONCAT "TAILQ_HEAD *head1" "TAILQ_HEAD *head2" "TAILQ_ENTRY NAME"
.Fn TAILQ_EMPTY "TAILQ_HEAD *head"
.Fn TAILQ_ENTRY "TYPE"
.Fn TAILQ_FIRST "TAILQ_HEAD *head"
@@ -180,6 +184,8 @@ Singly-linked tail queues add the following functionality:
.Bl -enum -compact -offset indent
.It
Entries can be added at the end of a list.
+.It
+They may be concatenated.
.El
However:
.Bl -enum -compact -offset indent
@@ -222,6 +228,8 @@ Tail queues add the following functionality:
Entries can be added at the end of a list.
.It
They may be traversed backwards, from tail to head.
+.It
+They may be concatenated.
.El
However:
.Bl -enum -compact -offset indent
@@ -429,6 +437,14 @@ evaluates to an initializer for the tail queue
.Fa head .
.Pp
The macro
+.Nm STAILQ_CONCAT
+concatenates the tail queue headed by
+.Fa head2
+onto the end of the one headed by
+.Fa head1
+removing all entries from the former.
+.Pp
+The macro
.Nm STAILQ_EMPTY
evaluates to true if there are no items on the tail queue.
.Pp
@@ -719,6 +735,14 @@ evaluates to an initializer for the tail queue
.Fa head .
.Pp
The macro
+.Nm TAILQ_CONCAT
+concatenates the tail queue headed by
+.Fa head2
+onto the end of the one headed by
+.Fa head1
+removing all entries from the former.
+.Pp
+The macro
.Nm TAILQ_EMPTY
evaluates to true if there are no items on the tail queue.
.Pp
OpenPOWER on IntegriCloud