diff mbox series

[07/22] list.3: SYNOPSIS: ffix: Use man markup

Message ID	20201020142146.61837-8-colomar.6.4.3@gmail.com
State	Not applicable
Headers	DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 1BB2E39450FF To: mtk.manpages@gmail.com Subject: [PATCH 07/22] list.3: SYNOPSIS: ffix: Use man markup Date: Tue, 20 Oct 2020 16:21:32 +0200 Message-Id: <20201020142146.61837-8-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 \| [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…

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 | 57 ++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 37 insertions(+), 20 deletions(-)

diff mbox series

Patch

diff --git a/man3/list.3 b/man3/list.3
index 0ea135900..8af4ccfd6 100644
--- a/man3/list.3
+++ b/man3/list.3
@@ -50,26 +50,43 @@  LIST_REMOVE
 .\"LIST_SWAP
 \- implementation of a doubly-linked list
 .SH SYNOPSIS
-.In sys/queue.h
-.\"
-.Fn LIST_EMPTY "LIST_HEAD *head"
-.Fn LIST_ENTRY "TYPE"
-.Fn LIST_FIRST "LIST_HEAD *head"
-.Fn LIST_FOREACH "TYPE *var" "LIST_HEAD *head" "LIST_ENTRY NAME"
-.\" .Fn LIST_FOREACH_FROM "TYPE *var" "LIST_HEAD *head" "LIST_ENTRY NAME"
-.\" .Fn LIST_FOREACH_SAFE "TYPE *var" "LIST_HEAD *head" "LIST_ENTRY NAME" "TYPE *temp_var"
-.\" .Fn LIST_FOREACH_FROM_SAFE "TYPE *var" "LIST_HEAD *head" "LIST_ENTRY NAME" "TYPE *temp_var"
-.Fn LIST_HEAD "HEADNAME" "TYPE"
-.Fn LIST_HEAD_INITIALIZER "LIST_HEAD head"
-.Fn LIST_INIT "LIST_HEAD *head"
-.Fn LIST_INSERT_AFTER "TYPE *listelm" "TYPE *elm" "LIST_ENTRY NAME"
-.Fn LIST_INSERT_BEFORE "TYPE *listelm" "TYPE *elm" "LIST_ENTRY NAME"
-.Fn LIST_INSERT_HEAD "LIST_HEAD *head" "TYPE *elm" "LIST_ENTRY NAME"
-.Fn LIST_NEXT "TYPE *elm" "LIST_ENTRY NAME"
-.\" .Fn LIST_PREV "TYPE *elm" "LIST_HEAD *head" "TYPE" "LIST_ENTRY NAME"
-.Fn LIST_REMOVE "TYPE *elm" "LIST_ENTRY NAME"
-.\" .Fn LIST_SWAP "LIST_HEAD *head1" "LIST_HEAD *head2" "TYPE" "LIST_ENTRY NAME"
-.\"
+.nf
+.B #include <sys/queue.h>
+.PP
+.BI "int LIST_EMPTY(LIST_HEAD *" head ");"
+.PP
+.B LIST_ENTRY(TYPE);
+.PP
+.BI "LIST_ENTRY *LIST_FIRST(LIST_HEAD *" head ");"
+.PP
+.BI "LIST_FOREACH(TYPE *" var ", LIST_HEAD *" head ", LIST_ENTRY " NAME ");"
+.\".PP
+.\".BI "LIST_FOREACH_FROM(TYPE *" var ", LIST_HEAD *" head ", LIST_ENTRY " NAME ");"
+.\".PP
+.\".BI "LIST_FOREACH_SAFE(TYPE *" var ", LIST_HEAD *" head ", LIST_ENTRY " NAME ", TYPE *" temp_var ");"
+.\".PP
+.\".BI "LIST_FOREACH_FROM_SAFE(TYPE *" var ", LIST_HEAD *" head ", LIST_ENTRY " NAME ", TYPE *" temp_var ");"
+.PP
+.B LIST_HEAD(HEADNAME, TYPE);
+.PP
+.BI "LIST_HEAD LIST_HEAD_INITIALIZER(LIST_HEAD " head ");"
+.PP
+.BI "void LIST_INIT(LIST_HEAD *" head ");"
+.PP
+.BI "void LIST_INSERT_AFTER(TYPE *" listelm ", TYPE *" elm ", LIST_ENTRY " NAME ");"
+.PP
+.BI "void LIST_INSERT_BEFORE(TYPE *" listelm ", TYPE *" elm ", LIST_ENTRY " NAME ");"
+.PP
+.BI "void LIST_INSERT_HEAD(LIST_HEAD *" head ", TYPE *" elm ", LIST_ENTRY " NAME ");"
+.PP
+.BI "LIST_ENTRY *LIST_NEXT(TYPE *" elm ", LIST_ENTRY " NAME ");"
+.\".PP
+.\".BI "LIST_ENTRY LIST_PREV(TYPE *" elm ", LIST_HEAD *" head ", TYPE, LIST_ENTRY " NAME ");"
+.PP
+.BI "void LIST_REMOVE(TYPE *" elm ", LIST_ENTRY " NAME ");"
+.\".PP
+.\".BI "void LIST_SWAP(LIST_HEAD *" head1 ", LIST_HEAD *" head2 ", TYPE, LIST_ENTRY " NAME ");"
+.fi
 .SH DESCRIPTION
 .SH RETURN VALUE
 .SH CONFORMING TO