Print this page 
12198 typo paramter in some section 3pool man pages
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man3pool/pool_associate.3pool
          +++ new/usr/src/man/man3pool/pool_associate.3pool
   1    1  '\" te
   2    2  .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
   3    3  .\" 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.
   4    4  .\" 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.
   5    5  .\" 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]
   6      -.TH POOL_ASSOCIATE 3POOL "April 9, 2016"
        6 +.TH POOL_ASSOCIATE 3POOL "January 15, 2020"
   7    7  .SH NAME
   8    8  pool_associate, pool_create, pool_destroy, pool_dissociate, pool_info,
   9    9  pool_query_pool_resources \- resource pool manipulation functions
  10   10  .SH SYNOPSIS
  11      -.LP
  12   11  .nf
  13   12  cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ]
  14   13  #include <pool.h>
  15   14  
  16   15  \fBint\fR \fBpool_associate\fR(\fBpool_conf_t *\fR\fIconf\fR, \fB pool_t *\fR\fIpool\fR,
  17   16       \fBpool_resource_t *\fR\fIresource\fR);
  18   17  .fi
  19   18  
  20   19  .LP
  21   20  .nf
↓ open down ↓ 17 lines elided ↑ open up ↑ 
  39   38       \fBint\fR \fIflags\fR);
  40   39  .fi
  41   40  
  42   41  .LP
  43   42  .nf
  44   43  \fBpool_resource_t **\fR\fBpool_query_pool_resources\fR(\fBpool_conf_t *\fR\fIconf\fR,
  45   44       \fBpool_t *\fR\fIpool\fR, \fBuint_t *\fR\fInelem\fR, \fBpool_value_t **\fR\fIproperties\fR);
  46   45  .fi
  47   46  
  48   47  .SH DESCRIPTION
  49      -.LP
  50   48  These functions provide mechanisms for constructing and modifying pools entries
  51   49  within a target pools configuration.  The \fIconf\fR argument for each function
  52   50  refers to the target configuration to which the operation applies.
  53   51  .sp
  54   52  .LP
  55   53  The \fBpool_associate()\fR function associates the specified resource with
  56   54  \fIpool\fR. A resource can be associated with multiple pools at the same time.
  57   55  Any resource of this type that was formerly associated with this pool is no
  58   56  longer associated with the pool. The new association replaces the earlier one.
  59   57  .sp
↓ open down ↓ 16 lines elided ↑ open up ↑ 
  76   74  string is allocated with \fBmalloc\fR(3C). The caller is responsible for freeing
  77   75  the returned string. If the \fIflags\fR option is non-zero, the string returned
  78   76  also describes the associated resources of the pool.
  79   77  .sp
  80   78  .LP
  81   79  The \fBpool_query_pool_resources()\fR function returns a null-terminated array
  82   80  of resources currently associated with the pool that match the given list of
  83   81  properties. The return value must be freed by the caller. The \fInelem\fR
  84   82  argument is set to be the length of the array returned.
  85   83  .SH RETURN VALUES
  86      -.LP
  87   84  Upon successful completion, \fBpool_create()\fR returns a new initialized pool.
  88   85  Otherwise it returns \fINULL\fR and \fBpool_error\fR(3POOL) returns the
  89   86  pool-specific error value.
  90   87  .sp
  91   88  .LP
  92   89  Upon successful completion, \fBpool_associate()\fR, \fBpool_destroy()\fR, and
  93   90  \fBpool_dissociate()\fR return 0. Otherwise, they return -1 and
  94   91  \fBpool_error()\fR returns the pool-specific error value.
  95   92  .sp
  96   93  .LP
  97   94  Upon successful completion, \fBpool_info()\fR returns a string describing the
  98   95  given pool. Otherwise it returns \fINULL\fR and \fBpool_error()\fR returns the
  99   96  pool-specific error value.
 100   97  .sp
 101   98  .LP
 102   99  Upon successful completion, \fBpool_query_pool_resources()\fR returns a
 103  100  null-terminated array of resources. Otherwise it returns \fINULL\fR and
 104  101  \fBpool_error()\fR returns the pool-specific error value.
 105  102  .SH ERRORS
 106      -.LP
 107  103  The \fBpool_create()\fR function will fail if:
 108  104  .sp
 109  105  .ne 2
 110  106  .na
 111  107  \fB\fBPOE_BADPARAM\fR\fR
 112  108  .ad
 113  109  .RS 20n
 114  110  The supplied configuration's status is not \fBPOF_VALID\fR or \fIname\fR is
 115  111  already in use.
 116  112  .RE
↓ open down ↓ 96 lines elided ↑ open up ↑ 
 213  209  .sp
 214  210  .LP
 215  211  The \fBpool_info()\fR function will fail if:
 216  212  .sp
 217  213  .ne 2
 218  214  .na
 219  215  \fB\fBPOE_BADPARAM\fR\fR
 220  216  .ad
 221  217  .RS 20n
 222  218  The supplied configuration's status is not \fBPOF_VALID\fR or the \fIflags\fR
 223      -paramter is neither 0 or 1.
      219 +parameter is neither 0 or 1.
 224  220  .RE
 225  221  
 226  222  .sp
 227  223  .ne 2
 228  224  .na
 229  225  \fB\fBPOE_INVALID_CONF\fR\fR
 230  226  .ad
 231  227  .RS 20n
 232  228  The configuration is invalid.
 233  229  .RE
↓ open down ↓ 31 lines elided ↑ open up ↑ 
 265  261  .sp
 266  262  .ne 2
 267  263  .na
 268  264  \fB\fBPOE_SYSTEM\fR\fR
 269  265  .ad
 270  266  .RS 20n
 271  267  A system error has occurred. Check the system error code for more details.
 272  268  .RE
 273  269  
 274  270  .SH USAGE
 275      -.LP
 276  271  Pool names are unique across pools in a given configuration file. It is an
 277  272  error to attempt to create a pool with a name that is currently used by another
 278  273  pool within the same configuration.
 279  274  .SH ATTRIBUTES
 280      -.LP
 281  275  See \fBattributes\fR(5) for descriptions of the following attributes:
 282  276  .sp
 283  277  
 284  278  .sp
 285  279  .TS
 286  280  box;
 287  281  c | c
 288  282  l | l .
 289  283  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 290  284  _
 291  285  CSI     Enabled
 292  286  _
 293  287  Interface Stability     Unstable
 294  288  _
 295  289  MT-Level        Safe
 296  290  .TE
 297  291  
 298  292  .SH SEE ALSO
 299      -.LP
 300  293  \fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX