diff mbox series

[6/8] stailq.3: Copy and adapt code from queue.3

Message ID 20201024222115.6362-7-colomar.6.4.3@gmail.com
State Not applicable
Headers
Series stailq.3 |

Commit Message

Alejandro Colomar Oct. 24, 2020, 10:21 p.m. UTC 
  Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
 man3/stailq.3 | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/man3/stailq.3 b/man3/stailq.3
index 88cdccbbc..9306176d2 100644
--- a/man3/stailq.3
+++ b/man3/stailq.3
@@ -52,6 +52,8 @@ 
 .Nm STAILQ_REMOVE_HEAD ,
 .\" .Nm STAILQ_SWAP ,
 .SH SYNOPSIS
+.In sys/queue.h
+.\"
 .Fn STAILQ_CONCAT "STAILQ_HEAD *head1" "STAILQ_HEAD *head2"
 .Fn STAILQ_EMPTY "STAILQ_HEAD *head"
 .Fn STAILQ_ENTRY "TYPE"
@@ -74,6 +76,18 @@ 
 .\" .Fn STAILQ_SWAP "STAILQ_HEAD *head1" "STAILQ_HEAD *head2" "STAILQ_ENTRY NAME"
 .\"
 .SH DESCRIPTION
+In the macro definitions,
+.Fa TYPE
+is the name of a user-defined structure,
+that must contain a field of type
+.Li STAILQ_ENTRY ,
+named
+.Fa NAME .
+The argument
+.Fa HEADNAME
+is the name of a user-defined structure that must be declared
+using the macro
+.Li STAILQ_HEAD .
 .Ss Singly-linked tail queues
 A singly-linked tail queue is headed by a structure defined by the
 .Nm STAILQ_HEAD
@@ -248,11 +262,12 @@  from the tail queue.
 .\" .Fa head1
 .\" and
 .\" .Fa head2 .
-.Pp
-See the EXAMPLES section below for an example program
-using a singly-linked tail queue.
 .SH RETURN VALUE
 .SH CONFORMING TO
+Not in POSIX.1, POSIX.1-2001 or POSIX.1-2008.
+Present on the BSDs
+(STAILQ macros first appeared in
+.Bx 4.4 ).
 .SH BUGS
 .SH EXAMPLES
 .Ss Singly-linked tail queue example
@@ -272,7 +287,7 @@  STAILQ_HEAD(stailhead, entry);
 int
 main(void)
 {
-    struct entry    *n1, *n2, *n3, *np;
+    struct entry *n1, *n2, *n3, *np;
     struct stailhead head;                  /* Singly-linked tail queue
                                                head. */