Module Name: src
Committed By: abhinav
Date: Sun Feb 12 16:00:53 UTC 2017
Modified Files:
src/common/lib/libprop: prop_array.3 prop_array_util.3 prop_bool.3
prop_data.3 prop_dictionary.3 prop_dictionary_util.3 prop_ingest.3
prop_number.3 prop_object.3 prop_send_ioctl.3 prop_send_syscall.3
prop_string.3
Log Message:
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.
To generate a diff of this commit:
cvs rdiff -u -r1.13 -r1.14 src/common/lib/libprop/prop_array.3
cvs rdiff -u -r1.9 -r1.10 src/common/lib/libprop/prop_array_util.3 \
src/common/lib/libprop/prop_send_ioctl.3
cvs rdiff -u -r1.6 -r1.7 src/common/lib/libprop/prop_bool.3 \
src/common/lib/libprop/prop_ingest.3
cvs rdiff -u -r1.7 -r1.8 src/common/lib/libprop/prop_data.3
cvs rdiff -u -r1.18 -r1.19 src/common/lib/libprop/prop_dictionary.3
cvs rdiff -u -r1.8 -r1.9 src/common/lib/libprop/prop_dictionary_util.3 \
src/common/lib/libprop/prop_object.3 src/common/lib/libprop/prop_string.3
cvs rdiff -u -r1.10 -r1.11 src/common/lib/libprop/prop_number.3
cvs rdiff -u -r1.5 -r1.6 src/common/lib/libprop/prop_send_syscall.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/common/lib/libprop/prop_array.3
diff -u src/common/lib/libprop/prop_array.3:1.13 src/common/lib/libprop/prop_array.3:1.14
--- src/common/lib/libprop/prop_array.3:1.13 Fri Sep 30 22:08:18 2011
+++ src/common/lib/libprop/prop_array.3 Sun Feb 12 16:00:53 2017
@@ -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 @@ Note: Objects contained in the array are
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_array_util.3
diff -u src/common/lib/libprop/prop_array_util.3:1.9 src/common/lib/libprop/prop_array_util.3:1.10
--- src/common/lib/libprop/prop_array_util.3:1.9 Tue May 31 09:31:13 2016
+++ src/common/lib/libprop/prop_array_util.3 Sun Feb 12 16:00:53 2017
@@ -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 @@ function adds the object to the end of t
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 @@ if the object exists in the array and th
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 @@ otherwise.
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_send_ioctl.3
diff -u src/common/lib/libprop/prop_send_ioctl.3:1.9 src/common/lib/libprop/prop_send_ioctl.3:1.10
--- src/common/lib/libprop/prop_send_ioctl.3:1.9 Thu Aug 20 15:55:09 2015
+++ src/common/lib/libprop/prop_send_ioctl.3 Sun Feb 12 16:00:53 2017
@@ -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 $
.\"
.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -54,12 +54,12 @@
"unsigned long cmd" "prop_dictionary_t *dictp"
.Sh DESCRIPTION
The
-.Nm prop_array_send_ioctl ,
-.Nm prop_array_recv_ioctl ,
-.Nm prop_dictionary_send_ioctl ,
-.Nm prop_dictionary_recv_ioctl ,
+.Fn prop_array_send_ioctl ,
+.Fn prop_array_recv_ioctl ,
+.Fn prop_dictionary_send_ioctl ,
+.Fn prop_dictionary_recv_ioctl ,
and
-.Nm prop_dictionary_sendrecv_ioctl
+.Fn prop_dictionary_sendrecv_ioctl
functions implement the user space side of a protocol for sending property
lists to and from the kernel using
.Xr ioctl 2 .
@@ -109,7 +109,7 @@ foo_getprops(void)
.Ed
.Pp
The
-.Nm prop_dictionary_sendrecv_ioctl
+.Fn prop_dictionary_sendrecv_ioctl
function combines the send and receive functionality, allowing for
ioctls that require two-way communication
.Pq for example to specify arguments for the ioctl operation .
@@ -146,6 +146,6 @@ errors may be returned.
.Xr prop_copyin_ioctl 9
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_bool.3
diff -u src/common/lib/libprop/prop_bool.3:1.6 src/common/lib/libprop/prop_bool.3:1.7
--- src/common/lib/libprop/prop_bool.3:1.6 Sun Aug 3 03:11:28 2008
+++ src/common/lib/libprop/prop_bool.3 Sun Feb 12 16:00:53 2017
@@ -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 @@ is returned.
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_ingest.3
diff -u src/common/lib/libprop/prop_ingest.3:1.6 src/common/lib/libprop/prop_ingest.3:1.7
--- src/common/lib/libprop/prop_ingest.3:1.6 Thu Feb 18 14:00:39 2010
+++ src/common/lib/libprop/prop_ingest.3 Sun Feb 12 16:00:53 2017
@@ -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 @@ The
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 in the dictionary was not the
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 @@ Returns the private data set when the co
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_data.3
diff -u src/common/lib/libprop/prop_data.3:1.7 src/common/lib/libprop/prop_data.3:1.8
--- src/common/lib/libprop/prop_data.3:1.7 Mon Dec 14 06:03:23 2009
+++ src/common/lib/libprop/prop_data.3 Sun Feb 12 16:00:53 2017
@@ -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 @@ is returned.
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_dictionary.3
diff -u src/common/lib/libprop/prop_dictionary.3:1.18 src/common/lib/libprop/prop_dictionary.3:1.19
--- src/common/lib/libprop/prop_dictionary.3:1.18 Fri Sep 30 22:08:18 2011
+++ src/common/lib/libprop/prop_dictionary.3 Sun Feb 12 16:00:53 2017
@@ -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 @@ if internalizing or writing the dictiona
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_dictionary_util.3
diff -u src/common/lib/libprop/prop_dictionary_util.3:1.8 src/common/lib/libprop/prop_dictionary_util.3:1.9
--- src/common/lib/libprop/prop_dictionary_util.3:1.8 Mon Oct 17 09:24:54 2011
+++ src/common/lib/libprop/prop_dictionary_util.3 Sun Feb 12 16:00:53 2017
@@ -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 @@ function adds the object to the dictiona
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 @@ if the object exists in the dictionary a
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 @@ otherwise.
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_object.3
diff -u src/common/lib/libprop/prop_object.3:1.8 src/common/lib/libprop/prop_object.3:1.9
--- src/common/lib/libprop/prop_object.3:1.8 Thu Jan 20 10:44:42 2011
+++ src/common/lib/libprop/prop_object.3 Sun Feb 12 16:00:53 2017
@@ -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 @@ Release the iterator
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_string.3
diff -u src/common/lib/libprop/prop_string.3:1.8 src/common/lib/libprop/prop_string.3:1.9
--- src/common/lib/libprop/prop_string.3:1.8 Sat Feb 26 12:56:36 2011
+++ src/common/lib/libprop/prop_string.3 Sun Feb 12 16:00:53 2017
@@ -1,4 +1,4 @@
-.\" $NetBSD: prop_string.3,v 1.8 2011/02/26 12:56:36 wiz Exp $
+.\" $NetBSD: prop_string.3,v 1.9 2017/02/12 16:00:53 abhinav Exp $
.\"
.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -84,7 +84,7 @@
.Fn prop_string_equals_cstring "prop_string_t string" "const char *cstring"
.Sh DESCRIPTION
The
-.Nm prop_string
+.Fn prop_string
family of functions operate on a string value property object type.
.Bl -tag -width "xxxxx"
.It Fn prop_string_create "void"
@@ -188,6 +188,6 @@ if the string's value is equivalent to
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_number.3
diff -u src/common/lib/libprop/prop_number.3:1.10 src/common/lib/libprop/prop_number.3:1.11
--- src/common/lib/libprop/prop_number.3:1.10 Thu Jan 20 10:44:42 2011
+++ src/common/lib/libprop/prop_number.3 Sun Feb 12 16:00:53 2017
@@ -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 @@ is returned.
.Xr proplib 3
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
Index: src/common/lib/libprop/prop_send_syscall.3
diff -u src/common/lib/libprop/prop_send_syscall.3:1.5 src/common/lib/libprop/prop_send_syscall.3:1.6
--- src/common/lib/libprop/prop_send_syscall.3:1.5 Fri Sep 30 22:08:18 2011
+++ src/common/lib/libprop/prop_send_syscall.3 Sun Feb 12 16:00:53 2017
@@ -1,4 +1,4 @@
-.\" $NetBSD: prop_send_syscall.3,v 1.5 2011/09/30 22:08:18 jym Exp $
+.\" $NetBSD: prop_send_syscall.3,v 1.6 2017/02/12 16:00:53 abhinav Exp $
.\"
.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -51,11 +51,11 @@
"prop_dictionary_t *dictp"
.Sh DESCRIPTION
The
-.Nm prop_array_send_syscall ,
-.Nm prop_array_recv_syscall ,
-.Nm prop_dictionary_send_syscall ,
+.Fn prop_array_send_syscall ,
+.Fn prop_array_recv_syscall ,
+.Fn prop_dictionary_send_syscall ,
and
-.Nm prop_dictionary_recv_syscall
+.Fn prop_dictionary_recv_syscall
functions implement the user space side of a protocol for sending property
lists to and from the kernel using
.Xr syscall 2 .
@@ -123,6 +123,6 @@ Not supported
.Xr prop_copyin_ioctl 9
.Sh HISTORY
The
-.Nm proplib
+.Xr proplib 3
property container object library first appeared in
.Nx 4.0 .
