6050 kstat_create(9f) should document KSTAT_TYPE_RAW and KSTAT_TYPE_TIMER

Reviewed by: Toomas Soome <tsoome@me.com>
Reviewed by: Marcel Telka <marcel@telka.sk>
Approved by: Robert Mustacchi <rm@joyent.com>

1 files changed, 21 insertions, 9 deletions

diff --git a/usr/src/man/man9f/kstat_create.9f b/usr/src/man/man9f/kstat_create.9f
index 2f6cd3e878..322b8d9d88 100644
--- a/usr/src/man/man9f/kstat_create.9f
+++ b/usr/src/man/man9f/kstat_create.9f
@@ -3,7 +3,7 @@
 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH KSTAT_CREATE 9F "Nov 13, 2006"
+.TH KSTAT_CREATE 9F "Sep 7, 2015"
 .SH NAME
 kstat_create \- create and initialize a new kstat
 .SH SYNOPSIS
@@ -20,11 +20,9 @@ kstat_create \- create and initialize a new kstat
 .fi
 
 .SH INTERFACE LEVEL
-.sp
 .LP
 Solaris DDI specific (Solaris DDI)
 .SH PARAMETERS
-.sp
 .ne 2
 .na
 \fB\fIks_module\fR\fR
@@ -75,10 +73,19 @@ The type of \fBkstat\fR to allocate. Valid types are:
 .sp
 .ne 2
 .na
+\fB\fBKSTAT_TYPE_RAW\fR\fR
+.ad
+.RS 20n
+Raw data; allows more than one data record per \fBkstat\fR.
+.RE
+
+.sp
+.ne 2
+.na
 \fB\fBKSTAT_TYPE_NAMED\fR\fR
 .ad
 .RS 20n
-Allows more than one data record per \fBkstat\fR.
+Name=value pairs; allows more than one data record per \fBkstat\fR.
 .RE
 
 .sp
@@ -96,7 +103,16 @@ Interrupt; only one data record per \fBkstat\fR.
 \fB\fBKSTAT_TYPE_IO\fR\fR
 .ad
 .RS 20n
-\fBI/O\fR; only one data record per \fBkstat\fR
+\fBI/O\fR; only one data record per \fBkstat\fR.
+.RE
+
+.sp
+.ne 2
+.na
+\fB\fBKSTAT_TYPE_TIMER\fR\fR
+.ad
+.RS 20n
+Event timer statistics; allows more than one data record per \fBkstat\fR.
 .RE
 
 .RE
@@ -157,7 +173,6 @@ goes away.
 .RE
 
 .SH DESCRIPTION
-.sp
 .LP
 \fBkstat_create()\fR is used in conjunction with \fBkstat_install\fR(9F) to
 allocate and initialize a \fBkstat\fR(9S) structure. The method is generally as
@@ -183,12 +198,10 @@ have the \fBks_data\fR field set at this time. The provider may also set the
 Once the \fBkstat\fR is completely initialized, \fBkstat_install\fR(9F) is used
 to make the \fBkstat\fR accessible to the outside world.
 .SH RETURN VALUES
-.sp
 .LP
 If successful, \fBkstat_create()\fR returns a pointer to the allocated
 \fBkstat\fR. \fINULL\fR is returned upon failure.
 .SH CONTEXT
-.sp
 .LP
 \fBkstat_create()\fR can be called from user or kernel context.
 .SH EXAMPLES
@@ -207,7 +220,6 @@ pkstat_t   *ksp;
 .in -2
 
 .SH SEE ALSO
-.sp
 .LP
 \fBkstat\fR(3KSTAT), \fBddi_get_instance\fR(9F), \fBkstat_delete\fR(9F),
 \fBkstat_install\fR(9F), \fBkstat_named_init\fR(9F), \fBkstat\fR(9S),