Print this page
12198 typo paramter in some section 3pool man pages
*** 1,17 ****
'\" te
.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
.\" 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"
.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>
\fBpool_resource_t *\fR\fBpool_resource_create\fR(\fBpool_conf_t *\fR\fIconf\fR,
--- 1,16 ----
'\" te
.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
.\" 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 "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
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <pool.h>
\fBpool_resource_t *\fR\fBpool_resource_create\fR(\fBpool_conf_t *\fR\fIconf\fR,
*** 50,60 ****
\fBpool_resource_t *\fR\fIsource\fR, \fBpool_resource_t *\fR\fItarget\fR,
\fBpool_component_t **\fR\fIcomponents\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.
.sp
.LP
--- 49,58 ----
*** 89,99 ****
.sp
.LP
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
error value.
.sp
--- 87,96 ----
*** 106,127 ****
describing the given resource (and optionally its components). Otherwise,
\fINULL\fR is returned and \fBpool_error()\fR returns the pool-specific error
value.
.sp
.LP
! 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
\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
.na
\fB\fBPOE_BADPARAM\fR\fR
--- 103,123 ----
describing the given resource (and optionally its components). Otherwise,
\fINULL\fR is returned and \fBpool_error()\fR returns the pool-specific error
value.
.sp
.LP
! 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
\fBpool_resource_xtransfer()\fR return 0. Otherwise -1 is returned and
\fBpool_error()\fR returns the pool-specific error value.
.SH ERRORS
The \fBpool_resource_create()\fR function will fail if:
.sp
.ne 2
.na
\fB\fBPOE_BADPARAM\fR\fR
*** 179,189 ****
.na
\fB\fBPOE_BADPARAM\fR\fR
.ad
.RS 20n
The supplied configuration's status is not \fBPOF_VALID\fR or the \fIflags\fR
! paramter is neither 0 nor 1.
.RE
.sp
.ne 2
.na
--- 175,185 ----
.na
\fB\fBPOE_BADPARAM\fR\fR
.ad
.RS 20n
The supplied configuration's status is not \fBPOF_VALID\fR or the \fIflags\fR
! parameter is neither 0 nor 1.
.RE
.sp
.ne 2
.na
*** 286,296 ****
.RS 20n
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
.nf
#include <pool.h>
--- 282,291 ----
*** 309,319 ****
}
.fi
.in -2
.SH ATTRIBUTES
- .LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.sp
.TS
--- 304,313 ----
*** 328,334 ****
_
MT-Level Safe
.TE
.SH SEE ALSO
- .LP
\fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)
--- 322,327 ----