summaryrefslogtreecommitdiff
path: root/usr/src/man/man3pool
diff options
context:
space:
mode:
authorPeter Tribble <peter.tribble@gmail.com>2020-01-18 12:13:39 +0000
committerPeter Tribble <peter.tribble@gmail.com>2020-01-20 15:29:15 +0000
commitb1d07aba78c3ce908f3d863c20e1c345bebf9bf6 (patch)
treeb92bbbf0a99a4a608c8332286cb7d1ec0ffb96a7 /usr/src/man/man3pool
parent3b379e2a4b3fe1592962563cb8c50c330ce393d8 (diff)
downloadillumos-joyent-b1d07aba78c3ce908f3d863c20e1c345bebf9bf6.tar.gz
12202 noise in example code in some section 3pool man pages
Reviewed by: Toomas Soome <tsoome@me.com> Reviewed by: Robert Mustacchi <rm@fingolfin.org> Reviewed by: Gergő Doma <domag02@gmail.com> Approved by: Dan McDonald <danmcd@joyent.com>
Diffstat (limited to 'usr/src/man/man3pool')
-rw-r--r--usr/src/man/man3pool/pool_get_binding.3pool20
-rw-r--r--usr/src/man/man3pool/pool_get_pool.3pool22
-rw-r--r--usr/src/man/man3pool/pool_resource_create.3pool4
3 files changed, 11 insertions, 35 deletions
diff --git a/usr/src/man/man3pool/pool_get_binding.3pool b/usr/src/man/man3pool/pool_get_binding.3pool
index b1cae5dedc..e0608a855e 100644
--- a/usr/src/man/man3pool/pool_get_binding.3pool
+++ b/usr/src/man/man3pool/pool_get_binding.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_GET_BINDING 3POOL "Mar 27, 2007"
+.TH POOL_GET_BINDING 3POOL "January 18, 2020"
.SH NAME
pool_get_binding, pool_set_binding, pool_get_resource_binding \- set and query
process to resource pool bindings
.SH SYNOPSIS
-.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <pool.h>
@@ -28,8 +27,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|
.fi
.SH DESCRIPTION
-.sp
-.LP
The \fBpool_get_binding()\fR function returns the name of the pool on the
running system that contains the set of resources to which the given process is
bound. If no such pool exists on the system or the search returns more than one
@@ -53,7 +50,7 @@ referenced by the pool; generally, this requirement is equivalent to requiring
superuser privilege.
.sp
.LP
-The \fIidtype\fR parameter can be of the following types:
+The \fIidtype\fR parameter can be one of the following types:
.sp
.ne 2
.na
@@ -88,11 +85,9 @@ The \fBpool_get_resource_binding()\fR function returns the name of the resource
of the supplied type to which the supplied process is bound.
.sp
.LP
-The application must explicity free the memory allocated for the return values
+The application must explicitly free the memory allocated for the return values
for \fBpool_get_binding()\fR and \fBpool_get_resource_binding()\fR.
.SH RETURN VALUES
-.sp
-.LP
Upon successful completion, \fBpool_get_binding()\fR returns the name of the
pool to which the process is bound. Otherwise it returns \fINULL\fR and
\fBpool_error\fR(3POOL) returns the pool-specific error value.
@@ -108,8 +103,6 @@ of the resource of the specified type to which the process is bound. Otherwise
it returns \fINULL\fR and \fBpool_error()\fR returns the pool-specific error
value.
.SH ERRORS
-.sp
-.LP
The \fBpool_get_binding()\fR function will fail if:
.sp
.ne 2
@@ -201,7 +194,6 @@ A system error has occurred. Check the system error code for more details.
.RE
.SH EXAMPLES
-.LP
\fBExample 1 \fRBind the current process to the pool named "target".
.sp
.in +2
@@ -217,15 +209,13 @@ id_t pid = getpid();
\&...
if (pool_set_binding("target", P_PID, pid) == PO_FAIL) \{
- (void) fprintf(stderr, "pool binding failed (\\%d)\\B{}n",
+ (void) fprintf(stderr, "pool binding failed (%d)\\n",
pool_error());
\}
.fi
.in -2
.SH ATTRIBUTES
-.sp
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -244,6 +234,4 @@ MT-Level Safe
.TE
.SH SEE ALSO
-.sp
-.LP
\fBlibpool\fR(3LIB), \fBpool_error\fR(3POOL), \fBattributes\fR(5)
diff --git a/usr/src/man/man3pool/pool_get_pool.3pool b/usr/src/man/man3pool/pool_get_pool.3pool
index 591a40fd3e..cc5665f367 100644
--- a/usr/src/man/man3pool/pool_get_pool.3pool
+++ b/usr/src/man/man3pool/pool_get_pool.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_GET_POOL 3POOL "Jul 18, 2005"
+.TH POOL_GET_POOL 3POOL "January 18, 2020"
.SH NAME
pool_get_pool, pool_get_resource, pool_query_components, pool_query_pools,
pool_query_resources \- retrieve resource pool configuration elements
.SH SYNOPSIS
-.LP
.nf
cc [ \fIflag\fR]\&.\|.\|. \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <pool.h>
@@ -41,8 +40,6 @@ cc [ \fIflag\fR]\&.\|.\|. \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|
.fi
.SH DESCRIPTION
-.sp
-.LP
These functions provide a means for querying the contents of the specified
configuration. The \fIconf\fR argument for each function refers to the target
configuration to which the operation applies.
@@ -73,8 +70,6 @@ The \fBpool_query_resources()\fR function similarly returns the list of
resources that match the given list of properties. The return value must be
freed by the caller.
.SH RETURN VALUES
-.sp
-.LP
The \fBpool_get_pool()\fR and \fBpool_get_resource()\fR functions return the
matching pool and resource, respectively. Otherwise, they return \fINULL\fR and
\fBpool_error\fR(3POOL) returns the pool-specific error value.
@@ -86,9 +81,7 @@ components, pools, and resources, respectively. If the query was unsuccessful
or there were no matches, \fINULL\fR is returned and \fBpool_error()\fR returns
the pool-specific error value.
.SH ERRORS
-.sp
-.LP
-The \fBpool_get_pool()\fR will fail if:
+The \fBpool_get_pool()\fR function will fail if:
.sp
.ne 2
.na
@@ -100,7 +93,7 @@ The supplied configuration's status is not \fBPOF_VALID\fR.
.sp
.LP
-The \fBpool_get_resource()\fR will fail if:
+The \fBpool_get_resource()\fR function will fail if:
.sp
.ne 2
.na
@@ -123,7 +116,7 @@ There is not enough memory available to allocate working buffers. Check
.sp
.LP
The \fBpool_query_components()\fR, \fBpool_query_pools()\fR, and
-\fBpool_query_resources()\fR will fail if:
+\fBpool_query_resources()\fR functions will fail if:
.sp
.ne 2
.na
@@ -154,7 +147,6 @@ There is not enough memory available to allocate working buffers. Check
.RE
.SH EXAMPLES
-.LP
\fBExample 1 \fRRetrieve the pool named "foo" from a given configuration.
.sp
.in +2
@@ -171,15 +163,13 @@ pool_t *pool;
if ((pool = pool_get_pool(conf, "foo")) == NULL) {
(void) fprintf(stderr, "Cannot retrieve pool named
- 'foo'\\B{}n");
+ 'foo'\\n");
...
}
.fi
.in -2
.SH ATTRIBUTES
-.sp
-.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -198,6 +188,4 @@ MT-Level Safe
.TE
.SH SEE ALSO
-.sp
-.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 5a14d1194d..08fb6283bc 100644
--- a/usr/src/man/man3pool/pool_resource_create.3pool
+++ b/usr/src/man/man3pool/pool_resource_create.3pool
@@ -3,7 +3,7 @@
.\" 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"
+.TH POOL_RESOURCE_CREATE 3POOL "January 18, 2020"
.SH NAME
pool_resource_create, pool_resource_destroy, pool_resource_info,
pool_query_resource_components, pool_resource_transfer, pool_resource_xtransfer
@@ -299,7 +299,7 @@ pool_resource_t *resource;
if ((resource = pool_resource_create(conf, "pset",
"foo")) == NULL) {
- (void) fprintf(stderr, "Cannot create resource\\B{}n");
+ (void) fprintf(stderr, "Cannot create resource\\n");
...
}
.fi