summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Tribble <peter.tribble@gmail.com>2020-01-15 21:13:06 +0000
committerPeter Tribble <peter.tribble@gmail.com>2020-01-18 11:59:39 +0000
commitbdd776d0084e7937ba9e46f78ea1d0cf3a673a94 (patch)
tree61ed2a43a9ebcd8281a9c47026d801ed52f7ada7
parentc3f3f3816bf6b9c1c6f71ea84d0907efc0a7dc7b (diff)
downloadillumos-joyent-bdd776d0084e7937ba9e46f78ea1d0cf3a673a94.tar.gz
12198 typo paramter in some section 3pool man pages
Reviewed by: Gergő Doma <domag02@gmail.com> Approved by: Dan McDonald <danmcd@joyent.com>
-rw-r--r--usr/src/man/man3pool/pool_associate.3pool11
-rw-r--r--usr/src/man/man3pool/pool_component_info.3pool10
-rw-r--r--usr/src/man/man3pool/pool_resource_create.3pool15
3 files changed, 8 insertions, 28 deletions
diff --git a/usr/src/man/man3pool/pool_associate.3pool b/usr/src/man/man3pool/pool_associate.3pool
index c98600fbbc..3e33318a4d 100644
--- a/usr/src/man/man3pool/pool_associate.3pool
+++ b/usr/src/man/man3pool/pool_associate.3pool
@@ -3,12 +3,11 @@
.\" 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 POOL_ASSOCIATE 3POOL "April 9, 2016"
+.TH POOL_ASSOCIATE 3POOL "January 15, 2020"
.SH NAME
pool_associate, pool_create, pool_destroy, pool_dissociate, pool_info,
pool_query_pool_resources \- resource pool manipulation functions
.SH SYNOPSIS
-.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <pool.h>
@@ -46,7 +45,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|
.fi
.SH DESCRIPTION
-.LP
These functions provide mechanisms for constructing and modifying pools entries
within a target pools configuration. The \fIconf\fR argument for each function
refers to the target configuration to which the operation applies.
@@ -83,7 +81,6 @@ of resources currently associated with the pool that match the given list of
properties. The return value must be freed by the caller. The \fInelem\fR
argument is set to be the length of the array returned.
.SH RETURN VALUES
-.LP
Upon successful completion, \fBpool_create()\fR returns a new initialized pool.
Otherwise it returns \fINULL\fR and \fBpool_error\fR(3POOL) returns the
pool-specific error value.
@@ -103,7 +100,6 @@ Upon successful completion, \fBpool_query_pool_resources()\fR returns a
null-terminated array of resources. Otherwise it returns \fINULL\fR and
\fBpool_error()\fR returns the pool-specific error value.
.SH ERRORS
-.LP
The \fBpool_create()\fR function will fail if:
.sp
.ne 2
@@ -220,7 +216,7 @@ The \fBpool_info()\fR function will fail if:
.ad
.RS 20n
The supplied configuration's status is not \fBPOF_VALID\fR or the \fIflags\fR
-paramter is neither 0 or 1.
+parameter is neither 0 or 1.
.RE
.sp
@@ -272,12 +268,10 @@ A system error has occurred. Check the system error code for more details.
.RE
.SH USAGE
-.LP
Pool names are unique across pools in a given configuration file. It is an
error to attempt to create a pool with a name that is currently used by another
pool within the same configuration.
.SH ATTRIBUTES
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -296,5 +290,4 @@ MT-Level Safe
.TE
.SH SEE ALSO
-.LP
\fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)
diff --git a/usr/src/man/man3pool/pool_component_info.3pool b/usr/src/man/man3pool/pool_component_info.3pool
index 12b90c4b07..92b6986f9a 100644
--- a/usr/src/man/man3pool/pool_component_info.3pool
+++ b/usr/src/man/man3pool/pool_component_info.3pool
@@ -3,12 +3,11 @@
.\" 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 POOL_COMPONENT_INFO 3POOL "April 9, 2016"
+.TH POOL_COMPONENT_INFO 3POOL "January 15, 2020"
.SH NAME
pool_component_info, pool_get_owning_resource \- resource pool component
functions
.SH SYNOPSIS
-.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <pool.h>
@@ -24,7 +23,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|
.fi
.SH DESCRIPTION
-.LP
Certain resources, such as processor sets, are composed of resource components.
Informational and ownership attributes of resource components are made
available with the \fBpool_component_info()\fR and
@@ -41,7 +39,6 @@ ignored.
The \fBpool_get_owning_resource()\fR function returns the resource currently
containing \fIcomponent\fR. Every component is contained by a resource.
.SH RETURN VALUES
-.LP
Upon successful completion, \fBpool_component_info()\fR returns a string.
Otherwise it returns \fINULL\fR and \fBpool_error\fR(3POOL) returns the
pool-specific error value.
@@ -51,7 +48,6 @@ Upon successful completion, \fBpool_get_owning_resource()\fR returns the owning
resource. Otherwise it returns \fINULL\fR and \fBpool_error()\fR returns the
pool-specific error value.
.SH ERRORS
-.LP
The \fBpool_component_info()\fR function will fail if:
.sp
.ne 2
@@ -60,7 +56,7 @@ The \fBpool_component_info()\fR function will fail if:
.ad
.RS 20n
The supplied configuration's status is not \fBPOF_VALID\fR or the \fIflags\fR
-paramter is neither 0 or 1.
+parameter is neither 0 or 1.
.RE
.sp
@@ -94,7 +90,6 @@ The supplied configuration's status is not \fBPOF_VALID\fR.
.RE
.SH ATTRIBUTES
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -113,5 +108,4 @@ MT-Level Safe
.TE
.SH SEE ALSO
-.LP
\fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)
diff --git a/usr/src/man/man3pool/pool_resource_create.3pool b/usr/src/man/man3pool/pool_resource_create.3pool
index f62e5103b1..5a14d1194d 100644
--- a/usr/src/man/man3pool/pool_resource_create.3pool
+++ b/usr/src/man/man3pool/pool_resource_create.3pool
@@ -3,13 +3,12 @@
.\" 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 POOL_RESOURCE_CREATE 3POOL "April 9, 2016"
+.TH POOL_RESOURCE_CREATE 3POOL "January 15, 2020"
.SH NAME
pool_resource_create, pool_resource_destroy, pool_resource_info,
pool_query_resource_components, pool_resource_transfer, pool_resource_xtransfer
\- resource pool resource manipulation functions
.SH SYNOPSIS
-.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <pool.h>
@@ -52,7 +51,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|
.fi
.SH DESCRIPTION
-.LP
The \fBpool_resource_create()\fR function creates and returns a new resource of
the given \fIname\fR and \fItype\fR in the provided configuration. If there is
already a resource of the given name, the operation will fail.
@@ -91,7 +89,6 @@ list of \fBpool_component_t\fR.
The \fIconf\fR argument for each function refers to the target configuration to
which the operation applies.
.SH RETURN VALUES
-.LP
Upon successful completion, \fBpool_resource_create()\fR returns a new
\fBpool_resource_t\fR with default properties initialized. Otherwise,
\fINULL\fR is returned and \fBpool_error\fR(3POOL) returns the pool-specific
@@ -108,18 +105,17 @@ describing the given resource (and optionally its components). Otherwise,
value.
.sp
.LP
- Upon successful completion, \fBpool_query_resource_components()\fR returns a
+Upon successful completion, \fBpool_query_resource_components()\fR returns a
null-terminated array of \fBpool_component_t *\fR that match the provided
null-terminated property list and are contained in the given resource.
Otherwise, \fINULL\fR is returned and \fBpool_error()\fR returns the
pool-specific error value.
.sp
.LP
- Upon successful completion, \fBpool_resource_transfer()\fR and
+Upon successful completion, \fBpool_resource_transfer()\fR and
\fBpool_resource_xtransfer()\fR return 0. Otherwise -1 is returned and
\fBpool_error()\fR returns the pool-specific error value.
.SH ERRORS
-.LP
The \fBpool_resource_create()\fR function will fail if:
.sp
.ne 2
@@ -181,7 +177,7 @@ The \fBpool_resource_info()\fR function will fail if:
.ad
.RS 20n
The supplied configuration's status is not \fBPOF_VALID\fR or the \fIflags\fR
-paramter is neither 0 nor 1.
+parameter is neither 0 nor 1.
.RE
.sp
@@ -288,7 +284,6 @@ A system error has occurred. Check the system error code for more details.
.RE
.SH EXAMPLES
-.LP
\fBExample 1 \fRCreate a new resource of type \fBpset\fR named \fBfoo\fR.
.sp
.in +2
@@ -311,7 +306,6 @@ if ((resource = pool_resource_create(conf, "pset",
.in -2
.SH ATTRIBUTES
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -330,5 +324,4 @@ MT-Level Safe
.TE
.SH SEE ALSO
-.LP
\fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)