linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Alejandro Colomar <colomar.6.4.3@gmail.com>
To: mtk.manpages@gmail.com
Cc: Alejandro Colomar <colomar.6.4.3@gmail.com>,
	linux-man@vger.kernel.org, libc-alpha@sourceware.org
Subject: [PATCH 8/8] stailq.3: Add remaining details to complete the page
Date: Sun, 25 Oct 2020 00:21:16 +0200	[thread overview]
Message-ID: <20201024222115.6362-9-colomar.6.4.3@gmail.com> (raw)
In-Reply-To: <20201024222115.6362-1-colomar.6.4.3@gmail.com>

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
 man3/stailq.3 | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/man3/stailq.3 b/man3/stailq.3
index 0abacd824..2896d27c9 100644
--- a/man3/stailq.3
+++ b/man3/stailq.3
@@ -51,6 +51,7 @@ STAILQ_REMOVE,
 .\"STAILQ_REMOVE_AFTER,
 STAILQ_REMOVE_HEAD,
 .\"STAILQ_SWAP
+\- implementation of a singly-linked tail queue
 .SH SYNOPSIS
 .nf
 .B #include <sys/queue.h>
@@ -100,6 +101,8 @@ STAILQ_REMOVE_HEAD,
 .\" .BI "                STAILQ_ENTRY " NAME ");"
 .fi
 .SH DESCRIPTION
+These macros define and operate on singly-linked tail queues.
+.PP
 In the macro definitions,
 .I TYPE
 is the name of a user-defined structure,
@@ -292,11 +295,38 @@ from the tail queue.
 .\" and
 .\" .IR head2 .
 .SH RETURN VALUE
+.BR STAILQ_EMPTY ()
+returns nonzero if the queue is empty,
+and zero if the queue contains at least one entry.
+.PP
+.BR STAILQ_FIRST (),
+and
+.BR STAILQ_NEXT ()
+return a pointer to the first or next
+.I STAILQ_ENTRY
+structure, respectively.
+.PP
+.BR STAILQ_HEAD_INITIALIZER ()
+returns an initializer that can be assigned to the queue
+.IR head .
 .SH CONFORMING TO
 Not in POSIX.1, POSIX.1-2001 or POSIX.1-2008.
 Present on the BSDs
 (STAILQ macros first appeared in 4.4BSD).
 .SH BUGS
+The macro
+.BR STAILQ_FOREACH ()
+doesn't allow
+.I var
+to be removed or freed within the loop,
+as it would interfere with the traversal.
+The macro
+.BR STAILQ_FOREACH_SAFE (),
+which is present on the BSDs but is not present in glibc,
+fixes this limitation by allowing
+.I var
+to safely be removed from the list and freed from within the loop
+without interfering with the traversal.
 .SH EXAMPLES
 .EX
 #include <stddef.h>
-- 
2.28.0


  parent reply	other threads:[~2020-10-24 22:21 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-24 22:21 [PATCH 0/8] stailq.3 Alejandro Colomar
2020-10-24 22:21 ` [PATCH 1/8] stailq.3: New page that will hold the (stailq) contents of queue.3 Alejandro Colomar
2020-10-24 22:21 ` [PATCH 2/8] queue.3, stailq.3: NAME: Move code from queue.3 to stailq.3 Alejandro Colomar
2020-10-24 22:21 ` [PATCH 3/8] queue.3, stailq.3: SYNOPSIS: " Alejandro Colomar
2020-10-24 22:21 ` [PATCH 4/8] queue.3, stailq.3: DESCRIPTION: Move stailq specific " Alejandro Colomar
2020-10-24 22:21 ` [PATCH 5/8] queue.3, stailq.3: EXAMPLES: Move stailq example " Alejandro Colomar
2020-10-24 22:21 ` [PATCH 6/8] stailq.3: Copy and adapt code from queue.3 Alejandro Colomar
2020-10-24 22:21 ` [PATCH 7/8] stailq.3: ffix: Use man markup Alejandro Colomar
2020-10-24 22:21 ` Alejandro Colomar [this message]
2020-10-24 22:30 ` [PATCH 09/10] STAILQ_CONCAT.3, STAILQ_EMPTY.3, STAILQ_ENTRY.3, STAILQ_FIRST.3, STAILQ_FOREACH.3, STAILQ_HEAD.3, STAILQ_HEAD_INITIALIZER.3, STAILQ_INIT.3, STAILQ_INSERT_AFTER.3, STAILQ_INSERT_HEAD.3, STAILQ_INSERT_TAIL.3, STAILQ_NEXT.3, STAILQ_REMOVE.3, STAILQ_REMOVE_HEAD.3: Link to the new stailq(3) page instead of queue(3) Alejandro Colomar
2020-10-24 22:30 ` [PATCH 10/10] queue.3: SEE ALSO: Add stailq(3) Alejandro Colomar
2020-10-25  9:13 ` [PATCH 0/8] stailq.3 Michael Kerrisk (man-pages)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201024222115.6362-9-colomar.6.4.3@gmail.com \
    --to=colomar.6.4.3@gmail.com \
    --cc=libc-alpha@sourceware.org \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).