Mercurial > illumos > git > illumos-gate
changeset 19393:1fa016d33bf1
12198 typo paramter in some section 3pool man pages
Reviewed by: Gergő Doma <domag02@gmail.com>
Approved by: Dan McDonald <danmcd@joyent.com>
author | Peter Tribble <peter.tribble@gmail.com> |
---|---|
date | Wed, 15 Jan 2020 21:13:06 +0000 |
parents | 4f1738442338 |
children | faa0ad55fea7 |
files | usr/src/man/man3pool/pool_associate.3pool usr/src/man/man3pool/pool_component_info.3pool usr/src/man/man3pool/pool_resource_create.3pool |
diffstat | 3 files changed, 8 insertions(+), 28 deletions(-) [+] |
line wrap: on
line diff
--- a/usr/src/man/man3pool/pool_associate.3pool Wed Jan 15 09:35:58 2020 -0800 +++ b/usr/src/man/man3pool/pool_associate.3pool Wed Jan 15 21:13:06 2020 +0000 @@ -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 @@ .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 @@ 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 @@ 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 @@ .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 @@ .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 @@ .TE .SH SEE ALSO -.LP \fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)
--- a/usr/src/man/man3pool/pool_component_info.3pool Wed Jan 15 09:35:58 2020 -0800 +++ b/usr/src/man/man3pool/pool_component_info.3pool Wed Jan 15 21:13:06 2020 +0000 @@ -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 @@ .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 @@ 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 @@ 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 @@ .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 @@ .RE .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -113,5 +108,4 @@ .TE .SH SEE ALSO -.LP \fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)
--- a/usr/src/man/man3pool/pool_resource_create.3pool Wed Jan 15 09:35:58 2020 -0800 +++ b/usr/src/man/man3pool/pool_resource_create.3pool Wed Jan 15 21:13:06 2020 +0000 @@ -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 @@ .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 @@ 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 @@ 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 @@ .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 @@ .RE .SH EXAMPLES -.LP \fBExample 1 \fRCreate a new resource of type \fBpset\fR named \fBfoo\fR. .sp .in +2 @@ -311,7 +306,6 @@ .in -2 .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -330,5 +324,4 @@ .TE .SH SEE ALSO -.LP \fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)