[PATCH 13/22] list.3: DESCRIPTION: ffix: Use man markup

Alejandro Colomar
2020-10-20T14:23:37Z

man3/list.3 | 154 +++++++++++++++++++++++++++-------------------------
1 file changed, 80 insertions(+), 74 deletions(-)

diff --git a/man3/list.3 b/man3/list.3
index 3c25b3e55..5b2a72fdb 100644
--- a/man3/list.3
+++ b/man3/list.3
@@ -102,9 +102,9 @@ The argument
is the name of a user defined structure that must be declared
using the macro
.BR LIST_HEAD ().
-.Ss Lists
+.PP
A list is headed by a structure defined by the
-.Nm LIST_HEAD
+.BR LIST_HEAD ()
macro.
This structure contains a single pointer to the first element
on the list.
@@ -113,143 +113,149 @@ removed without traversing the list.
New elements can be added to the list after an existing element,
before an existing element, or at the head of the list.
A
-.Fa LIST_HEAD
+.I LIST_HEAD
structure is declared as follows:
-.Bd -literal -offset indent
+.PP
+.in +4
+.EX
LIST_HEAD(HEADNAME, TYPE) head;
-.Ed
-.Pp
+.EE
+.in
+.PP
where
-.Fa HEADNAME
+.I HEADNAME
is the name of the structure to be defined, and
-.Fa TYPE
+.I TYPE
is the type of the elements to be linked into the list.
A pointer to the head of the list can later be declared as:
-.Bd -literal -offset indent
+.PP
+.in +4
+.EX
struct HEADNAME *headp;
-.Ed
-.Pp
+.EE
+.in
+.PP
(The names
-.Li head
+.I head
and
-.Li headp
+.I headp
are user selectable.)
-.Pp
+.PP
The macro
-.Nm LIST_HEAD_INITIALIZER
+.BR LIST_HEAD_INITIALIZER ()
evaluates to an initializer for the list
-.Fa head .
-.Pp
+.IR head .
+.PP
The macro
-.Nm LIST_EMPTY
+.BR LIST_EMPTY ()
evaluates to true if there are no elements in the list.
-.Pp
+.PP
The macro
-.Nm LIST_ENTRY
+.BR LIST_ENTRY ()
declares a structure that connects the elements in
the list.
-.Pp
+.PP
The macro
-.Nm LIST_FIRST
+.BR LIST_FIRST ()
returns the first element in the list or NULL if the list
is empty.
-.Pp
+.PP
The macro
-.Nm LIST_FOREACH
+.BR LIST_FOREACH ()
traverses the list referenced by
-.Fa head
+.I head
in the forward direction, assigning each element in turn to
-.Fa var .
-.\" .Pp
+.IR var .
+.\" .PP
.\" The macro
-.\" .Nm LIST_FOREACH_FROM
+.\" .BR LIST_FOREACH_FROM ()
.\" behaves identically to
-.\" .Nm LIST_FOREACH
+.\" .BR LIST_FOREACH ()
.\" when
-.\" .Fa var
+.\" .I var
.\" is NULL, else it treats
-.\" .Fa var
+.\" .I var
.\" as a previously found LIST element and begins the loop at
-.\" .Fa var
+.\" .I var
.\" instead of the first element in the LIST referenced by
-.\" .Fa head .
-.\" .Pp
+.\" .IR head .
+.\" .PP
.\" The macro
-.\" .Nm LIST_FOREACH_SAFE
+.\" .BR LIST_FOREACH_SAFE ()
.\" traverses the list referenced by
-.\" .Fa head
+.\" .I head
.\" in the forward direction, assigning each element in turn to
-.\" .Fa var .
+.\" .IR var .
.\" However, unlike
-.\" .Fn LIST_FOREACH
+.\" .BR LIST_FOREACH ()
.\" here it is permitted to both remove
-.\" .Fa var
+.\" .I var
.\" as well as free it from within the loop safely without interfering with the
.\" traversal.
-.\" .Pp
+.\" .PP
.\" The macro
-.\" .Nm LIST_FOREACH_FROM_SAFE
+.\" .BR LIST_FOREACH_FROM_SAFE ()
.\" behaves identically to
-.\" .Nm LIST_FOREACH_SAFE
+.\" .BR LIST_FOREACH_SAFE ()
.\" when
-.\" .Fa var
+.\" .I var
.\" is NULL, else it treats
-.\" .Fa var
+.\" .I var
.\" as a previously found LIST element and begins the loop at
-.\" .Fa var
+.\" .I var
.\" instead of the first element in the LIST referenced by
-.\" .Fa head .
-.Pp
+.\" .IR head .
+.PP
The macro
-.Nm LIST_INIT
+.BR LIST_INIT ()
initializes the list referenced by
-.Fa head .
-.Pp
+.IR head .
+.PP
The macro
-.Nm LIST_INSERT_HEAD
+.BR LIST_INSERT_HEAD ()
inserts the new element
-.Fa elm
+.I elm
at the head of the list.
-.Pp
+.PP
The macro
-.Nm LIST_INSERT_AFTER
+.BR LIST_INSERT_AFTER ()
inserts the new element
-.Fa elm
+.I elm
after the element
-.Fa listelm .
-.Pp
+.IR listelm .
+.PP
The macro
-.Nm LIST_INSERT_BEFORE
+.BR LIST_INSERT_BEFORE ()
inserts the new element
-.Fa elm
+.I elm
before the element
-.Fa listelm .
-.Pp
+.IR listelm .
+.PP
The macro
-.Nm LIST_NEXT
+.BR LIST_NEXT ()
returns the next element in the list, or NULL if this is the last.
-.\" .Pp
+.\" .PP
.\" The macro
-.\" .Nm LIST_PREV
+.\" .BR LIST_PREV ()
.\" returns the previous element in the list, or NULL if this is the first.
.\" List
-.\" .Fa head
+.\" .I head
.\" must contain element
-.\" .Fa elm .
-.Pp
+.\" .IR elm .
+.PP
The macro
-.Nm LIST_REMOVE
+.BR LIST_REMOVE ()
removes the element
-.Fa elm
+.I elm
from the list.
-.\" .Pp
+.\" .PP
.\" The macro
-.\" .Nm LIST_SWAP
+.\" .BR LIST_SWAP ()
.\" swaps the contents of
-.\" .Fa head1
+.\" .I head1
.\" and
-.\" .Fa head2 .
-.Pp
+.\" .IR head2 .
+.PP
See the EXAMPLES section below for an example program using a linked list.