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,
	Hans Petter Selasky <hps@selasky.org>
Subject: [PATCH v2 08/10] list.3: Add details
Date: Tue, 20 Oct 2020 23:31:06 +0200	[thread overview]
Message-ID: <20201020213107.83837-9-colomar.6.4.3@gmail.com> (raw)
In-Reply-To: <20201020142146.61837-23-colomar.6.4.3@gmail.com>

list.3: NAME: Add description
list.3: DESCRIPTION: Add short description
list.3: SEE ALSO: Add insque(3) and queue(3)
list.3: BUGS: Note LIST_FOREACH() limitations
list.3: RETURN VALUE: Add details about the return value of those macros that "return" a value

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

diff --git a/man3/list.3 b/man3/list.3
index 0f9b20d26..8233c3b3e 100644
--- a/man3/list.3
+++ b/man3/list.3
@@ -48,6 +48,7 @@ LIST_NEXT,
 LIST_PREV,
 LIST_REMOVE
 .\"LIST_SWAP
+\- implementation of a doubly-linked list
 .SH SYNOPSIS
 .nf
 .B #include <sys/queue.h>
@@ -87,6 +88,8 @@ LIST_REMOVE
 .\".BI "void LIST_SWAP(LIST_HEAD *" head1 ", LIST_HEAD *" head2 ", TYPE, LIST_ENTRY " NAME ");"
 .fi
 .SH DESCRIPTION
+These macros define and operate on doubly-linked lists.
+.PP
 In the macro definitions,
 .I TYPE
 is the name of a user defined structure,
@@ -253,11 +256,39 @@ from the list.
 .\" and
 .\" .IR head2 .
 .SH RETURN VALUE
+.BR LIST_EMPTY ()
+returns non-zero if the list is empty,
+and zero if the list contains at least one entry.
+.PP
+.BR LIST_FIRST (),
+and
+.BR LIST_NEXT ()
+return a pointer to the first or next
+.I LIST_ENTRY
+structre, respectively.
+.PP
+.BR LIST_HEAD_INITIALIZER ()
+returns an initializer that can be assigned to the list
+.IR head .
 .SH CONFORMING TO
 Not in POSIX.1, POSIX.1-2001 or POSIX.1-2008.
 Present on the BSDs
 (LIST macros first appeared in 4.4BSD).
 .SH BUGS
+The macro
+.BR LIST_FOREACH ()
+doesn't allow
+.I var
+to be removed or freed within the loop,
+as it would interfere with the traversal.
+The macro
+.BR LIST_FOREACH_SAFE (),
+which is not present in glibc,
+solves this bug by
+allowing to both remove
+.I var
+as well as free it from within the loop safely
+without interfering with the traversal.
 .SH EXAMPLES
 .EX
 #include <stddef.h>
@@ -312,3 +343,5 @@ main(void)
 }
 .EE
 .SH SEE ALSO
+.BR insque (3),
+.BR queue (3)
-- 
2.28.0


  parent reply	other threads:[~2020-10-20 21:31 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-20 14:21 [PATCH 00/22] list.3: New page forked from queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 01/22] list.3: New page that will hold the (list) contents of queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 02/22] list.3, queue.3: NAME: Move code from queue.3 to list.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 03/22] list.3: NAME: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 04/22] list.3: NAME: Add description Alejandro Colomar
2020-10-20 14:21 ` [PATCH 05/22] list.3, queue.3: SYNOPSIS: Move code from queue.3 to list.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 06/22] list.3: SYNOPSIS: Copy include from queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 07/22] list.3: SYNOPSIS: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 08/22] list.3: DESCRIPTION: Add short description Alejandro Colomar
2020-10-20 14:21 ` [PATCH 09/22] list.3: DESCRIPTION: Copy description about naming of macros from queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 10/22] list.3: DESCRIPTION: Remove unrelated code to adapt to this page Alejandro Colomar
2020-10-20 14:21 ` [PATCH 11/22] list.3: DESCRIPTION: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 12/22] list.3, queue.3: DESCRIPTION: Move list specific code from queue.3 to list.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 13/22] list.3: DESCRIPTION: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 14/22] list.3: DESCRIPTION: Remove line pointing to the EXAMPLES Alejandro Colomar
2020-10-20 14:21 ` [PATCH 15/22] list.3: CONFORMING TO: Copy from queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 16/22] list.3: CONFORMING TO: Adapt to this page Alejandro Colomar
2020-10-20 14:21 ` [PATCH 17/22] list.3: CONFORMING TO: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 18/22] list.3: SEE ALSO: Add insque(3) and queue(3) Alejandro Colomar
2020-10-20 14:21 ` [PATCH 19/22] list.3, queue.3: EXAMPLES: Move example program from queue.3 to list.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 20/22] list.3: EXAMPLES: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 21/22] list.3: BUGS: Note LIST_FOREACH() limitations Alejandro Colomar
2020-10-20 14:21 ` [PATCH 22/22] list.3: RETURN VALUE: Add details about the return value of those macros that "return" a value Alejandro Colomar
2020-10-20 21:30   ` [PATCH v2 00/10] list.3: New page forked from queue.3 Alejandro Colomar
2020-10-21  4:52     ` Michael Kerrisk (man-pages)
2020-10-20 21:30   ` [PATCH v2 01/10] list.3: New page that will hold the (list) contents of queue.3 Alejandro Colomar
2020-10-20 21:31   ` [PATCH v2 02/10] list.3, queue.3: NAME: Move code from queue.3 to list.3 Alejandro Colomar
2020-10-20 21:31   ` [PATCH v2 03/10] list.3, queue.3: SYNOPSIS: " Alejandro Colomar
2020-10-20 21:31   ` [PATCH v2 04/10] list.3, queue.3: DESCRIPTION: Move list specific " Alejandro Colomar
2020-10-20 21:31   ` [PATCH v2 05/10] list.3, queue.3: EXAMPLES: Move example program " Alejandro Colomar
2020-10-20 21:31   ` [PATCH v2 06/10] list.3: Copy and adapt code from queue.3 Alejandro Colomar
2020-10-20 21:31   ` [PATCH v2 07/10] list.3: ffix: Use man markup Alejandro Colomar
2020-10-20 21:31   ` Alejandro Colomar [this message]
2020-10-20 21:31   ` [PATCH v2 09/10] LIST_EMPTY.3, LIST_ENTRY.3, LIST_FIRST.3, LIST_FOREACH.3, LIST_HEAD.3, LIST_HEAD_INITIALIZER.3, LIST_INIT.3, LIST_INSERT_AFTER.3, LIST_INSERT_BEFORE.3, LIST_INSERT_HEAD.3, LIST_NEXT.3, LIST_REMOVE.3: Link to the new list.3 page instead of queue.3 Alejandro Colomar
2020-10-20 21:31   ` [PATCH v2 10/10] queue.3: SEE ALSO: Add list(3) Alejandro Colomar
2020-10-20 18:57 ` [PATCH 00/22] list.3: New page forked from queue.3 Michael Kerrisk (man-pages)
2020-10-20 19:21   ` Alejandro Colomar
2020-10-20 19:33     ` 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=20201020213107.83837-9-colomar.6.4.3@gmail.com \
    --to=colomar.6.4.3@gmail.com \
    --cc=hps@selasky.org \
    --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).