summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorschwarze <schwarze@openbsd.org>2020-08-10 11:33:58 +0000
committerschwarze <schwarze@openbsd.org>2020-08-10 11:33:58 +0000
commit7592d7ef816c3d29a9fa4f76a60699357c41809d (patch)
tree305f0f0a4f05927d5959987695dc3394e1ff3f43
parentSet `IFXF_MPSAFE' bit to pppac(4) related `ifnet'. This moves pppac(4) (diff)
downloadwireguard-openbsd-7592d7ef816c3d29a9fa4f76a60699357c41809d.tar.xz
wireguard-openbsd-7592d7ef816c3d29a9fa4f76a60699357c41809d.zip
minor polishing: fix typos, add HISTORY and AUTHORS, a few wording
simplifications, add missing markup, and break an overlong line
-rw-r--r--share/man/man9/kstat_create.930
-rw-r--r--share/man/man9/kstat_kv_init.943
2 files changed, 51 insertions, 22 deletions
diff --git a/share/man/man9/kstat_create.9 b/share/man/man9/kstat_create.9
index b879aa9dedc..4e8b36391d4 100644
--- a/share/man/man9/kstat_create.9
+++ b/share/man/man9/kstat_create.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: kstat_create.9,v 1.1 2020/07/06 11:48:03 dlg Exp $
+.\" $OpenBSD: kstat_create.9,v 1.2 2020/08/10 11:33:58 schwarze Exp $
.\"
.\" Copyright (c) 2020 David Gwynne <dlg@openbsd.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: July 6 2020 $
+.Dd $Mdocdate: August 10 2020 $
.Dt KSTAT_CREATE 9
.Os
.Sh NAME
@@ -28,7 +28,7 @@
.Sh SYNOPSIS
.In sys/kstat.h
.Ft struct kstat *
-.Fo kstatap_create
+.Fo kstat_create
.Fa "const char *provider"
.Fa "unsigned int instance"
.Fa "const char *name"
@@ -52,7 +52,9 @@ statistics (kstat) API.
.Pp
The
.Fn kstat_create
-function allocates a kstat structure and adds it to the list of statistics that userland can query.
+function allocates a
+.Vt kstat
+structure and adds it to the list of statistics that userland can query.
A kstat is uniquely identified by a tuple made up of the
.Fa provider ,
.Fa instances ,
@@ -76,18 +78,21 @@ See
for more detail.
.El
.Pp
-Once a kstat structure has been created, the caller is responsible for initialising the structure.
+Once a
+.Vt kstat
+structure has been created,
+the caller is responsible for initialising the structure.
.Pp
After the structure has been initialised,
.Fn kstat_install
-notifies the kstat subsystem that the kstat structure
+notifies the kstat subsystem that
.Fa ks
can be used to export information to userland.
.Pp
.Fn kstat_destroy
-removes the
+removes
.Fa ks
- kstat structure from the list of exported statistics and frees it.
+from the list of exported statistics and frees it.
.\" might want a kstat_remove...
.Sh CONTEXT
.Fn kstat_create ,
@@ -100,8 +105,15 @@ and
can be called during autoconf, or from process context.
.Sh RETURN VALUES
.Fn kstat_create
-returns a pointer to an kstat structure on success, of
+returns a pointer to a
+.Vt kstat
+structure on success, or
.Dv NULL
on failure.
.Sh SEE ALSO
.Xr kstat_kv_init 9
+.Sh HISTORY
+These functions first appeared in
+.Ox 6.8 .
+.Sh AUTHORS
+.An David Gwynne Aq Mt dlg@openbsd.org
diff --git a/share/man/man9/kstat_kv_init.9 b/share/man/man9/kstat_kv_init.9
index 94fd78bca46..522a76db988 100644
--- a/share/man/man9/kstat_kv_init.9
+++ b/share/man/man9/kstat_kv_init.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: kstat_kv_init.9,v 1.1 2020/07/06 11:48:03 dlg Exp $
+.\" $OpenBSD: kstat_kv_init.9,v 1.2 2020/08/10 11:33:58 schwarze Exp $
.\"
.\" Copyright (c) 2020 David Gwynne <dlg@openbsd.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: July 6 2020 $
+.Dd $Mdocdate: August 10 2020 $
.Dt KSTAT_KV_INIT 9
.Os
.Sh NAME
@@ -48,11 +48,13 @@
.Fa "enum kstat_kv_unit unit"
.Fc
.Sh DESCRIPTION
-The kstat key/value data API supports the creation and maintenance
-of kstat_kv structures that can be exported to userland using the
-kstat API.
+The kstat key/value data API supports the creation and maintenance of
+.Vt kstat_kv
+structures that can be exported to userland using the kstat API.
.Pp
-A kstat key/value data payload for a kstat structure
+A kstat key/value data payload for a
+.Vt kstat
+structure
.Po
created using
.Xr kstat_create 9
@@ -62,7 +64,9 @@ as the
.Fa type
argument
.Pc
-is a series of kstat_kv structures in memory.
+is a series of
+.Vt kstat_kv
+structures in memory.
kstat_kv values are typed, and the memory used to store values of
different types is either inline as part of the structure, or is
extra bytes following a structure of a specified length.
@@ -70,7 +74,7 @@ extra bytes following a structure of a specified length.
.\" kstat_kv structures contain the following fields:
.Pp
.Fn kstat_kv_init
-initialises the kstat_kv structure
+initialises
.Fa kv
with a name specified as
.Fa key .
@@ -78,7 +82,7 @@ The type of the value is specified as
.Fa type .
.Pp
.Fn kstat_kv_unit_init
-initialises the kstat_kv structure
+initialises
.Fa kv
with a name specified as
.Fa key .
@@ -87,18 +91,26 @@ The integer or counter type of the value is specified as
and specifies the units for the values in
.Fa unit .
.Pp
-A kstat_kv structure can be initialised at compile time with the
+A
+.Vt kstat_kv
+structure can be initialised at compile time with the
.Fn KSTAT_KV_INITIALIZER
macro.
-The kstat_kv structure will be declared with the name
+The
+.Vt kstat_kv
+structure will be declared with the name
.Fa key
with the type of the values as
.Fa type .
.Pp
-A kstat_kv structure can be initialised at compile time with the
+A
+.Vt kstat_kv
+structure can be initialised at compile time with the
.Fn KSTAT_KV_UNIT_INITIALIZER
macro.
-The kstat_kv structure will be declared with the name
+The
+.Vt kstat_kv
+structure will be declared with the name
.Fa key
with the integer or counter type of the values as
.Fa type ,
@@ -106,3 +118,8 @@ and specifies the units for the values in
.Fa unit .
.Sh SEE ALSO
.Xr kstat_create 9
+.Sh HISTORY
+These functions first appeared in
+.Ox 6.8 .
+.Sh AUTHORS
+.An David Gwynne Aq Mt dlg@openbsd.org