[src/trunk]: src/common/lib/libprop Use .Fn to refer a function name instead ...

To: source-changes-hg%NetBSD.org@localhost
Subject: [src/trunk]: src/common/lib/libprop Use .Fn to refer a function name instead ...
From: abhinav <abhinav%NetBSD.org@localhost>
Date: Tue, 31 Jul 2018 20:54:58 +0000
details:   https://anonhg.NetBSD.org/src/rev/4a66ca3ed6b6
branches:  trunk
changeset: 351411:4a66ca3ed6b6
user:      abhinav <abhinav%NetBSD.org@localhost>
date:      Sun Feb 12 16:00:53 2017 +0000

description:
Use .Fn to refer a function name instead of Nm.
Also, use Xr to refer problib(3) in the HISTORY section instead of Nm.

While parsing the man pages, any .Nm occurrence gets replaced by the
value specified in the NAME section. Referencing individual function
names with .Nm was causing makemandb(8) to replicate the complete
NAME section for every such occurrence. This was leading to an
ugly looking snippet in apropos(1)'s output when searched for
any of these man pages.

diffstat:

 common/lib/libprop/prop_array.3           |   6 +++---
 common/lib/libprop/prop_array_util.3      |  10 +++++-----
 common/lib/libprop/prop_bool.3            |   6 +++---
 common/lib/libprop/prop_data.3            |   6 +++---
 common/lib/libprop/prop_dictionary.3      |   6 +++---
 common/lib/libprop/prop_dictionary_util.3 |  10 +++++-----
 common/lib/libprop/prop_ingest.3          |  11 +++++------
 common/lib/libprop/prop_number.3          |   6 +++---
 common/lib/libprop/prop_object.3          |   6 +++---
 common/lib/libprop/prop_send_ioctl.3      |  16 ++++++++--------
 common/lib/libprop/prop_send_syscall.3    |  12 ++++++------
 common/lib/libprop/prop_string.3          |   6 +++---
 12 files changed, 50 insertions(+), 51 deletions(-)

diffs (truncated from 397 to 300 lines):

diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_array.3
--- a/common/lib/libprop/prop_array.3   Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_array.3   Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_array.3,v 1.13 2011/09/30 22:08:18 jym Exp $
+.\"    $NetBSD: prop_array.3,v 1.14 2017/02/12 16:00:53 abhinav Exp $
 .\"
 .\" Copyright (c) 2006, 2009 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -113,7 +113,7 @@
 .Fn prop_array_equals "prop_array_t array1" "prop_array_t array2"
 .Sh DESCRIPTION
 The
-.Nm prop_array
+.Fn prop_array
 family of functions operate on the array property collection object type.
 An array is an ordered set; an iterated array will return objects in the
 same order with which they were stored.
@@ -303,6 +303,6 @@
 .Xr proplib 3
 .Sh HISTORY
 The
-.Nm proplib
+.Xr proplib 3
 property container object library first appeared in
 .Nx 4.0 .
diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_array_util.3
--- a/common/lib/libprop/prop_array_util.3      Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_array_util.3      Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_array_util.3,v 1.9 2016/05/31 09:31:13 wiz Exp $
+.\"    $NetBSD: prop_array_util.3,v 1.10 2017/02/12 16:00:53 abhinav Exp $
 .\"
 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -176,7 +176,7 @@
     "prop_object_t obj"
 .Sh DESCRIPTION
 The
-.Nm prop_array_util
+.Fn prop_array_util
 family of functions are provided to make getting and setting values in
 arrays more convenient in some applications.
 .Pp
@@ -211,7 +211,7 @@
 The object is also released on failure.
 .Sh RETURN VALUES
 The
-.Nm prop_array_util
+.Fn prop_array_util
 getter functions return
 .Dv true
 if the object exists in the array and the value is in-range, or
@@ -219,7 +219,7 @@
 otherwise.
 .Pp
 The
-.Nm prop_array_util
+.Fn prop_array_util
 setter functions return
 .Dv true
 if creating the object and storing it in the array is successful, or
@@ -232,6 +232,6 @@
 .Xr proplib 3
 .Sh HISTORY
 The
-.Nm proplib
+.Xr proplib 3
 property container object library first appeared in
 .Nx 4.0 .
diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_bool.3
--- a/common/lib/libprop/prop_bool.3    Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_bool.3    Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_bool.3,v 1.6 2008/08/03 03:11:28 thorpej Exp $
+.\"    $NetBSD: prop_bool.3,v 1.7 2017/02/12 16:00:53 abhinav Exp $
 .\"
 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -50,7 +50,7 @@
 .Fn prop_bool_true "prop_bool_t bool"
 .Sh DESCRIPTION
 The
-.Nm prop_bool
+.Fn prop_bool
 family of functions operate on a boolean value property object type.
 .Bl -tag -width "xxxxx"
 .It Fn prop_bool_create "bool val"
@@ -77,6 +77,6 @@
 .Xr proplib 3
 .Sh HISTORY
 The
-.Nm proplib
+.Xr proplib 3
 property container object library first appeared in
 .Nx 4.0 .
diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_data.3
--- a/common/lib/libprop/prop_data.3    Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_data.3    Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_data.3,v 1.7 2009/12/14 06:03:23 dholland Exp $
+.\"    $NetBSD: prop_data.3,v 1.8 2017/02/12 16:00:53 abhinav Exp $
 .\"
 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -67,7 +67,7 @@
 .Fn prop_data_equals_data "prop_data_t data" "const void *blob" "size_t len"
 .Sh DESCRIPTION
 The
-.Nm prop_data
+.Fn prop_data
 family of functions operate on an opaque data value property object type.
 .Bl -tag -width "xxxxx"
 .It Fn prop_data_create_data "const void *blob" "size_t len"
@@ -143,6 +143,6 @@
 .Xr proplib 3
 .Sh HISTORY
 The
-.Nm proplib
+.Xr proplib 3
 property container object library first appeared in
 .Nx 4.0 .
diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_dictionary.3
--- a/common/lib/libprop/prop_dictionary.3      Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_dictionary.3      Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_dictionary.3,v 1.18 2011/09/30 22:08:18 jym Exp $
+.\"    $NetBSD: prop_dictionary.3,v 1.19 2017/02/12 16:00:53 abhinav Exp $
 .\"
 .\" Copyright (c) 2006, 2009 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -137,7 +137,7 @@
 .\"
 .Sh DESCRIPTION
 The
-.Nm prop_dictionary
+.Fn prop_dictionary
 family of functions operate on the dictionary property collection object type.
 A dictionary is an unordered set of objects stored as key-value pairs.
 .Bl -tag -width "xxxxx"
@@ -348,6 +348,6 @@
 .Xr proplib 3
 .Sh HISTORY
 The
-.Nm proplib
+.Xr proplib 3
 property container object library first appeared in
 .Nx 4.0 .
diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_dictionary_util.3
--- a/common/lib/libprop/prop_dictionary_util.3 Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_dictionary_util.3 Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_dictionary_util.3,v 1.8 2011/10/17 09:24:54 wiz Exp $
+.\"    $NetBSD: prop_dictionary_util.3,v 1.9 2017/02/12 16:00:53 abhinav Exp $
 .\"
 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -142,7 +142,7 @@
     "const char *key" "prop_object_t obj"
 .Sh DESCRIPTION
 The
-.Nm prop_dictionary_util
+.Fn prop_dictionary_util
 family of functions are provided to make getting and setting values in
 dictionaries more convenient in some applications.
 .Pp
@@ -174,7 +174,7 @@
 The object is also released on failure.
 .Sh RETURN VALUES
 The
-.Nm prop_dictionary_util
+.Fn prop_dictionary_util
 getter functions return
 .Dv true
 if the object exists in the dictionary and the value is in-range, or
@@ -182,7 +182,7 @@
 otherwise.
 .Pp
 The
-.Nm prop_dictionary_util
+.Fn prop_dictionary_util
 setter functions return
 .Dv true
 if creating the object and storing it in the dictionary is successful, or
@@ -195,6 +195,6 @@
 .Xr proplib 3
 .Sh HISTORY
 The
-.Nm proplib
+.Xr proplib 3
 property container object library first appeared in
 .Nx 4.0 .
diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_ingest.3
--- a/common/lib/libprop/prop_ingest.3  Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_ingest.3  Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_ingest.3,v 1.6 2010/02/18 14:00:39 wiz Exp $
+.\"    $NetBSD: prop_ingest.3,v 1.7 2017/02/12 16:00:53 abhinav Exp $
 .\"
 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -62,13 +62,13 @@
 .Fn (*prop_ingest_handler_t) "prop_ingest_context_t" "prop_object_t"
 .Sh DESCRIPTION
 The
-.Nm prop_dictionary_ingest
+.Fn prop_dictionary_ingest
 function provides a convenient way to convert a property list into
 an arbitrary binary format or to extract values from dictionaries in a
 way that is convenient to an application
 .Pq for configuration files, for example .
 .Pp
-.Nm prop_dictionary_ingest
+.Fn prop_dictionary_ingest
 is driven by a table of rules provided by the application.
 Each rule consists of three items:
 .Bl -bullet
@@ -107,7 +107,7 @@
 macro marks the end of the rules table.
 .Pp
 In each case,
-.Nm prop_dictionary_ingest
+.Fn prop_dictionary_ingest
 looks up the rule's key in the dictionary.
 If an object is present in the dictionary at that key, its type is checked
 against the type specified in the rule.
@@ -158,7 +158,6 @@
 An object's handler returned
 .Dv false .
 .El
-.Pp
 .It Fn prop_ingest_context_type "prop_ingest_context_t ctx"
 Returns the type of the last object visited during an ingest.
 When called by an ingest handler, it returns the type of the object
@@ -176,6 +175,6 @@
 .Xr proplib 3
 .Sh HISTORY
 The
-.Nm proplib
+.Xr proplib 3
 property container object library first appeared in
 .Nx 4.0 .
diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_number.3
--- a/common/lib/libprop/prop_number.3  Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_number.3  Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_number.3,v 1.10 2011/01/20 10:44:42 wiz Exp $
+.\"    $NetBSD: prop_number.3,v 1.11 2017/02/12 16:00:53 abhinav Exp $
 .\"
 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -72,7 +72,7 @@
 .Fn prop_number_equals_unsigned_integer "prop_number_t number" "uint64_t val"
 .Sh DESCRIPTION
 The
-.Nm prop_number
+.Fn prop_number
 family of functions operate on a numeric value property object type.
 Values are either signed or unsigned, and promoted to a 64-bit type
 .Pq int64_t or uint64_t , respectively .
@@ -205,6 +205,6 @@
 .Xr proplib 3
 .Sh HISTORY
 The
-.Nm proplib
+.Xr proplib 3
 property container object library first appeared in
 .Nx 4.0 .
diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_object.3
--- a/common/lib/libprop/prop_object.3  Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_object.3  Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_object.3,v 1.8 2011/01/20 10:44:42 wiz Exp $
+.\"    $NetBSD: prop_object.3,v 1.9 2017/02/12 16:00:53 abhinav Exp $
 .\"
 .\" Copyright (c) 2006 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -63,7 +63,7 @@
 .Fn prop_object_iterator_release "prop_object_iterator_t iter"
 .Sh DESCRIPTION
 The
-.Nm prop_object
+.Fn prop_object
 family of functions operate on all property container object types.
 .Bl -tag -width ""
 .It Fn prop_object_retain "prop_object_t obj"
@@ -136,6 +136,6 @@
 .Xr proplib 3
 .Sh HISTORY
 The
-.Nm proplib
+.Xr proplib 3
 property container object library first appeared in
 .Nx 4.0 .
diff -r ff991b2623f7 -r 4a66ca3ed6b6 common/lib/libprop/prop_send_ioctl.3
--- a/common/lib/libprop/prop_send_ioctl.3      Sun Feb 12 14:45:09 2017 +0000
+++ b/common/lib/libprop/prop_send_ioctl.3      Sun Feb 12 16:00:53 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: prop_send_ioctl.3,v 1.9 2015/08/20 15:55:09 phx Exp $
+.\"    $NetBSD: prop_send_ioctl.3,v 1.10 2017/02/12 16:00:53 abhinav Exp $
Prev by Date: [src/trunk]: src/sys/arch/amiga/stand/bootblock/installboot Uninitialized var...
Next by Date: [src/trunk]: src/sys/kern Add a KASSERT, otherwise it looks like a NULL deref...
Previous by Thread: [src/trunk]: src/sys/arch/amiga/stand/bootblock/installboot Uninitialized var...
Next by Thread: [src/trunk]: src/sys/kern Add a KASSERT, otherwise it looks like a NULL deref...
Indexes:
Home | Main Index | Thread Index | Old Index