Print this page 
12198 typo paramter in some section 3pool man pages
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man3pool/pool_component_info.3pool
          +++ new/usr/src/man/man3pool/pool_component_info.3pool
   1    1  '\" te
   2    2  .\" Copyright (c) 2003, 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_COMPONENT_INFO 3POOL "April 9, 2016"
        6 +.TH POOL_COMPONENT_INFO 3POOL "January 15, 2020"
   7    7  .SH NAME
   8    8  pool_component_info, pool_get_owning_resource \- resource pool component
   9    9  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  \fBconst char *\fR\fBpool_component_info\fR(\fBpool_conf_t *\fR\fIconf\fR,
  17   16       \fBpool_component_t *\fR\fIcomponent\fR, \fBint\fR \fIflags\fR);
  18   17  .fi
  19   18  
  20   19  .LP
  21   20  .nf
  22   21  \fBpool_resource_t *\fR\fBpool_get_owning_resource\fR(\fBpool_conf_t *\fR\fIconf\fR,
  23   22       \fBpool_component_t *\fR\fIcomponent\fR);
  24   23  .fi
  25   24  
  26   25  .SH DESCRIPTION
  27      -.LP
  28   26  Certain resources, such as processor sets, are composed of resource components.
  29   27  Informational and ownership attributes of resource components are made
  30   28  available with the \fBpool_component_info()\fR and
  31   29  \fBpool_get_owning_resource()\fR functions. The \fIconf\fR argument for each
  32   30  function refers to the target configuration to which the operation applies.
  33   31  .sp
  34   32  .LP
  35   33  The \fBpool_component_info()\fR function returns a string describing
  36   34  \fIcomponent\fR. The string is allocated with \fBmalloc\fR(3C). The caller is
  37   35  responsible for freeing the returned string. The \fIflags\fR argument is
  38   36  ignored.
  39   37  .sp
  40   38  .LP
  41   39  The \fBpool_get_owning_resource()\fR function returns the resource currently
  42   40  containing \fIcomponent\fR.  Every component is contained by a resource.
  43   41  .SH RETURN VALUES
  44      -.LP
  45   42  Upon successful completion, \fBpool_component_info()\fR returns a string.
  46   43  Otherwise it returns \fINULL\fR and \fBpool_error\fR(3POOL) returns the
  47   44  pool-specific error value.
  48   45  .sp
  49   46  .LP
  50   47  Upon successful completion, \fBpool_get_owning_resource()\fR returns the owning
  51   48  resource. Otherwise it returns \fINULL\fR and \fBpool_error()\fR returns the
  52   49  pool-specific error value.
  53   50  .SH ERRORS
  54      -.LP
  55   51  The \fBpool_component_info()\fR function will fail if:
  56   52  .sp
  57   53  .ne 2
  58   54  .na
  59   55  \fB\fBPOE_BADPARAM\fR\fR
  60   56  .ad
  61   57  .RS 20n
  62   58  The supplied configuration's status is not \fBPOF_VALID\fR or the \fIflags\fR
  63      -paramter is neither 0 or 1.
       59 +parameter is neither 0 or 1.
  64   60  .RE
  65   61  
  66   62  .sp
  67   63  .ne 2
  68   64  .na
  69   65  \fB\fBPOE_INVALID_CONF\fR\fR
  70   66  .ad
  71   67  .RS 20n
  72   68  The configuration is invalid.
  73   69  .RE
↓ open down ↓ 13 lines elided ↑ open up ↑ 
  87   83  .sp
  88   84  .ne 2
  89   85  .na
  90   86  \fB\fBPOE_BADPARAM\fR\fR
  91   87  .ad
  92   88  .RS 16n
  93   89  The supplied configuration's status is not \fBPOF_VALID\fR.
  94   90  .RE
  95   91  
  96   92  .SH ATTRIBUTES
  97      -.LP
  98   93  See \fBattributes\fR(5) for descriptions of the following attributes:
  99   94  .sp
 100   95  
 101   96  .sp
 102   97  .TS
 103   98  box;
 104   99  c | c
 105  100  l | l .
 106  101  ATTRIBUTE TYPE  ATTRIBUTE VALUE
 107  102  _
 108  103  CSI     Enabled
 109  104  _
 110  105  Interface Stability     Unstable
 111  106  _
 112  107  MT-Level        Safe
 113  108  .TE
 114  109  
 115  110  .SH SEE ALSO
 116      -.LP
 117  111  \fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX