[src/trunk]: src/share/man/man3 Use Fn instead of Nm to refer the macros in t...

To: source-changes-hg%NetBSD.org@localhost
Subject: [src/trunk]: src/share/man/man3 Use Fn instead of Nm to refer the macros in t...
From: abhinav <abhinav%NetBSD.org@localhost>
Date: Tue, 07 Apr 2020 08:05:07 +0000

details:   https://anonhg.NetBSD.org/src/rev/6bcc60db47eb
branches:  trunk
changeset: 823485:6bcc60db47eb
user:      abhinav <abhinav%NetBSD.org@localhost>
date:      Tue Apr 25 06:08:24 2017 +0000

description:
Use Fn instead of Nm to refer the macros in the body of the man page.

Thanks to wiz@ for reviewing.

diffstat:

 share/man/man3/queue.3 |  170 ++++++++++++++++++++++++------------------------
 1 files changed, 85 insertions(+), 85 deletions(-)

diffs (truncated from 514 to 300 lines):

diff -r 04aa91ad8855 -r 6bcc60db47eb share/man/man3/queue.3
--- a/share/man/man3/queue.3    Tue Apr 25 05:44:11 2017 +0000
+++ b/share/man/man3/queue.3    Tue Apr 25 06:08:24 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: queue.3,v 1.55 2017/04/22 22:36:00 abhinav Exp $
+.\"    $NetBSD: queue.3,v 1.56 2017/04/25 06:08:24 abhinav Exp $
 .\"
 .\" Copyright (c) 2000, 2002 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -406,7 +406,7 @@
 .TE
 .Sh SINGLY-LINKED LISTS
 A singly-linked list is headed by a structure defined by the
-.Nm SLIST_HEAD
+.Fn SLIST_HEAD
 macro.
 This structure contains a single pointer to the first element
 on the list.
@@ -438,28 +438,28 @@
 are user selectable.)
 .Pp
 The macro
-.Nm SLIST_HEAD_INITIALIZER
+.Fn SLIST_HEAD_INITIALIZER
 evaluates to an initializer for the list
 .Fa head .
 .Pp
 The macro
-.Nm SLIST_ENTRY
+.Fn SLIST_ENTRY
 declares a structure that connects the elements in
 the list.
 .Pp
 The macro
-.Nm SLIST_FIRST
+.Fn SLIST_FIRST
 returns the first element in the list or NULL if the list is empty.
 .Pp
 The macro
-.Nm SLIST_EMPTY
+.Fn SLIST_EMPTY
 evaluates to true if there are no elements in the list.
 .Pp
 The macro
-.Nm SLIST_NEXT
+.Fn SLIST_NEXT
 returns the next element in the list.
 .Pp
-.Nm SLIST_FOREACH
+.Fn SLIST_FOREACH
 traverses the list referenced by
 .Fa head
 in the forward direction, assigning each element in
@@ -473,45 +473,45 @@
 may be freed or removed from the list.
 .Pp
 The macro
-.Nm SLIST_INIT
+.Fn SLIST_INIT
 initializes the list referenced by
 .Fa head .
 .Pp
 The macro
-.Nm SLIST_INSERT_HEAD
+.Fn SLIST_INSERT_HEAD
 inserts the new element
 .Fa elm
 at the head of the list.
 .Pp
 The macro
-.Nm SLIST_INSERT_AFTER
+.Fn SLIST_INSERT_AFTER
 inserts the new element
 .Fa elm
 after the element
 .Fa listelm .
 .Pp
 The macro
-.Nm SLIST_REMOVE
+.Fn SLIST_REMOVE
 removes the element
 .Fa elm
 from the list.
 .Pp
 The macro
-.Nm SLIST_REMOVE_HEAD
+.Fn SLIST_REMOVE_HEAD
 removes the first element from the head of the list.
 For optimum efficiency,
 elements being removed from the head of the list should explicitly use
 this macro instead of the generic
-.Nm SLIST_REMOVE
+.Fn SLIST_REMOVE
 macro.
 .Pp
 The macro
-.Nm SLIST_REMOVE_AFTER
+.Fn SLIST_REMOVE_AFTER
 removes the element after the one specified.
 For optimum efficiency,
 elements being removed after a specified one should explicitly use
 this macro instead of the generic
-.Nm SLIST_REMOVE
+.Fn SLIST_REMOVE
 .Sh SINGLY-LINKED LIST EXAMPLE
 .Bd -literal
 SLIST_HEAD(slisthead, entry) head =
@@ -549,7 +549,7 @@
 .Ed
 .Sh LISTS
 A list is headed by a structure defined by the
-.Nm LIST_HEAD
+.Fn LIST_HEAD
 macro.
 This structure contains a single pointer to the first element
 on the list.
@@ -581,12 +581,12 @@
 are user selectable.)
 .Pp
 The macro
-.Nm LIST_ENTRY
+.Fn LIST_ENTRY
 declares a structure that connects the elements in
 the list.
 .Pp
 The macro
-.Nm LIST_HEAD_INITIALIZER
+.Fn LIST_HEAD_INITIALIZER
 provides a value which can be used to initialize a list head at
 compile time, and is used at the point that the list head
 variable is declared, like:
@@ -595,23 +595,23 @@
 .Ed
 .Pp
 The macro
-.Nm LIST_FIRST
+.Fn LIST_FIRST
 returns the first element of the list
 .Fa head .
 .Pp
 The macro
-.Nm LIST_EMPTY
+.Fn LIST_EMPTY
 returns true if the list
 .Fa head
 has no elements.
 .Pp
 The macro
-.Nm LIST_NEXT
+.Fn LIST_NEXT
 returns the element after the element
 .Fa elm .
 .Pp
 The macro
-.Nm LIST_FOREACH
+.Fn LIST_FOREACH
 traverses the list referenced by
 .Fa head
 in the forward direction, assigning each element in turn to
@@ -624,38 +624,38 @@
 may be freed or removed from the list.
 .Pp
 The macro
-.Nm LIST_INIT
+.Fn LIST_INIT
 initializes the list referenced by
 .Fa head .
 .Pp
 The macro
-.Nm LIST_INSERT_AFTER
+.Fn LIST_INSERT_AFTER
 inserts the new element
 .Fa elm
 after the element
 .Fa listelm .
 .Pp
 The macro
-.Nm LIST_INSERT_BEFORE
+.Fn LIST_INSERT_BEFORE
 inserts the new element
 .Fa elm
 before the element
 .Fa listelm .
 .Pp
 The macro
-.Nm LIST_INSERT_HEAD
+.Fn LIST_INSERT_HEAD
 inserts the new element
 .Fa elm
 at the head of the list.
 .Pp
 The macro
-.Nm LIST_REMOVE
+.Fn LIST_REMOVE
 removes the element
 .Fa elm
 from the list.
 .Pp
 The macro
-.Nm LIST_REPLACE
+.Fn LIST_REPLACE
 replaces the element
 .Fa elm
 with
@@ -663,7 +663,7 @@
 in the list.
 .Pp
 The macro
-.Nm LIST_MOVE
+.Fn LIST_MOVE
 moves the list headed by
 .Fa head1
 onto the list headed by
@@ -700,7 +700,7 @@
 .Ed
 .Sh SIMPLE QUEUES
 A simple queue is headed by a structure defined by the
-.Nm SIMPLEQ_HEAD
+.Fn SIMPLEQ_HEAD
 macro.
 This structure contains a pair of pointers,
 one to the first element in the simple queue and the other to
@@ -733,12 +733,12 @@
 are user selectable.)
 .Pp
 The macro
-.Nm SIMPLEQ_ENTRY
+.Fn SIMPLEQ_ENTRY
 declares a structure that connects the elements in
 the simple queue.
 .Pp
 The macro
-.Nm SIMPLEQ_HEAD_INITIALIZER
+.Fn SIMPLEQ_HEAD_INITIALIZER
 provides a value which can be used to initialize a simple queue head at
 compile time, and is used at the point that the simple queue head
 variable is declared, like:
@@ -747,29 +747,29 @@
 .Ed
 .Pp
 The macro
-.Nm SIMPLEQ_FIRST
+.Fn SIMPLEQ_FIRST
 returns the first element of the simple queue
 .Fa head .
 .Pp
 The macro
-.Nm SIMPLEQ_EMPTY
+.Fn SIMPLEQ_EMPTY
 returns true if the simple queue
 .Fa head
 has no elements.
 .Pp
 The macro
-.Nm SIMPLEQ_NEXT
+.Fn SIMPLEQ_NEXT
 returns the element after the element
 .Fa elm .
 .Pp
 The macro
-.Nm SIMPLEQ_LAST
+.Fn SIMPLEQ_LAST
 returns the last item on the tail queue.
 If the tail queue is empty the return value is
 .Dv NULL .
 .Pp
 The macro
-.Nm SIMPLEQ_FOREACH
+.Fn SIMPLEQ_FOREACH
 traverses the tail queue referenced by
 .Fa head
 in the forward direction, assigning each element
@@ -783,55 +783,55 @@
 may be freed or removed from the list.
 .Pp
 The macro
-.Nm SIMPLEQ_INIT
+.Fn SIMPLEQ_INIT
 initializes the simple queue referenced by
 .Fa head .
 .Pp
 The macro
-.Nm SIMPLEQ_INSERT_HEAD
+.Fn SIMPLEQ_INSERT_HEAD
 inserts the new element
 .Fa elm
 at the head of the simple queue.
 .Pp
 The macro
-.Nm SIMPLEQ_INSERT_TAIL
+.Fn SIMPLEQ_INSERT_TAIL
 inserts the new element
 .Fa elm
 at the end of the simple queue.
 .Pp
 The macro
-.Nm SIMPLEQ_INSERT_AFTER
+.Fn SIMPLEQ_INSERT_AFTER
 inserts the new element
 .Fa elm

Prev by Date: [src/trunk]: src/sys/kern Use __func__ for routine name in printf() calls. N...
Next by Date: [src/trunk]: src/sys/arch/arm/arm Report trapframe where possible
Previous by Thread: [src/trunk]: src/sys/kern Use __func__ for routine name in printf() calls. N...
Next by Thread: [src/trunk]: src/sys/arch/arm/arm Report trapframe where possible
Indexes:

Home | Main Index | Thread Index | Old Index