[21/22] list.3: BUGS: Note LIST_FOREACH() limitations

Message ID	20201020142146.61837-22-colomar.6.4.3@gmail.com
State	New
Headers	show Return-Path: <libc-alpha-bounces@sourceware.org> DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 462BA394743E To: mtk.manpages@gmail.com Subject: [PATCH 21/22] list.3: BUGS: Note LIST_FOREACH() limitations Date: Tue, 20 Oct 2020 16:21:46 +0200 Message-Id: <20201020142146.61837-22-colomar.6.4.3@gmail.com> In-Reply-To: <20201020142146.61837-1-colomar.6.4.3@gmail.com> References: <20201020142146.61837-1-colomar.6.4.3@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: list From: Alejandro Colomar via Libc-alpha <libc-alpha@sourceware.org> Reply-To: Alejandro Colomar <colomar.6.4.3@gmail.com> Cc: Alejandro Colomar <colomar.6.4.3@gmail.com>, linux-man@vger.kernel.org, libc-alpha@sourceware.org Errors-To: libc-alpha-bounces@sourceware.org Sender: "Libc-alpha" <libc-alpha-bounces@sourceware.org>
Series	list.3: New page forked from queue.3 \| expand [00/22] list.3: New page forked from queue.3 [01/22] list.3: New page that will hold the (list) contents of queue.3 [02/22] list.3, queue.3: NAME: Move code from queue.3 to list.3 [03/22] list.3: NAME: ffix: Use man markup [04/22] list.3: NAME: Add description [05/22] list.3, queue.3: SYNOPSIS: Move code from queue.3 to list.3 [06/22] list.3: SYNOPSIS: Copy include from queue.3 [07/22] list.3: SYNOPSIS: ffix: Use man markup [08/22] list.3: DESCRIPTION: Add short description [09/22] list.3: DESCRIPTION: Copy description about naming of macros from queue.3 [10/22] list.3: DESCRIPTION: Remove unrelated code to adapt to this page [11/22] list.3: DESCRIPTION: ffix: Use man markup [12/22] list.3, queue.3: DESCRIPTION: Move list specific code from queue.3 to list.3 [13/22] list.3: DESCRIPTION: ffix: Use man markup [14/22] list.3: DESCRIPTION: Remove line pointing to the EXAMPLES [15/22] list.3: CONFORMING TO: Copy from queue.3 [16/22] list.3: CONFORMING TO: Adapt to this page [17/22] list.3: CONFORMING TO: ffix: Use man markup [18/22] list.3: SEE ALSO: Add insque(3) and queue(3) [19/22] list.3, queue.3: EXAMPLES: Move example program from queue.3 to list.3 [20/22] list.3: EXAMPLES: ffix: Use man markup [21/22] list.3: BUGS: Note LIST_FOREACH() limitations [22/22] list.3: RETURN VALUE: Add details about the return value of those macros that "return" a va…

Message ID

20201020142146.61837-22-colomar.6.4.3@gmail.com

State

New

Headers

DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 462BA394743E
To: mtk.manpages@gmail.com
Subject: [PATCH 21/22] list.3: BUGS: Note LIST_FOREACH() limitations
Date: Tue, 20 Oct 2020 16:21:46 +0200
Message-Id: <20201020142146.61837-22-colomar.6.4.3@gmail.com>
In-Reply-To: <20201020142146.61837-1-colomar.6.4.3@gmail.com>
References: <20201020142146.61837-1-colomar.6.4.3@gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: list
From: Alejandro Colomar via Libc-alpha <libc-alpha@sourceware.org>
Reply-To: Alejandro Colomar <colomar.6.4.3@gmail.com>
Cc: Alejandro Colomar <colomar.6.4.3@gmail.com>, linux-man@vger.kernel.org,
 libc-alpha@sourceware.org
Errors-To: libc-alpha-bounces@sourceware.org
Sender: "Libc-alpha" <libc-alpha-bounces@sourceware.org>

Series

list.3: New page forked from queue.3 | expand

Commit Message

Alejandro Colomar Oct. 20, 2020, 2:21 p.m. UTC

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

diff --git a/man3/list.3 b/man3/list.3
index bb64fff92..4aec14cc8 100644
--- a/man3/list.3
+++ b/man3/list.3
@@ -261,6 +261,20 @@  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>

[21/22] list.3: BUGS: Note LIST_FOREACH() limitations

Commit Message

Patch