diff mbox series

[22/22] list.3: RETURN VALUE: Add details about the return value of those macros that "return" a value

Message ID 20201020142146.61837-23-colomar.6.4.3@gmail.com
State Not Applicable
Headers show
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 mbox series

Patch

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