attempt to clarify bit about flags usage:

* remove mention to PR_URGENT, since it was removed from the code
    two years ago
  * mention PR_NOWAIT
This commit is contained in:
pooka 2004-03-24 17:44:22 +00:00
parent 5aab77f087
commit ba81fe2a70
1 changed files with 9 additions and 18 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pool.9,v 1.32 2004/03/08 23:02:40 wiz Exp $
.\" $NetBSD: pool.9,v 1.33 2004/03/24 17:44:22 pooka Exp $
.\"
.\" Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -34,7 +34,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd March 9, 2004
.Dd March 24, 2004
.Dt POOL 9
.Os
.Sh NAME
@ -135,27 +135,18 @@ The arguments are:
.It Fa pp
The handle identifying the pool resource instance.
.It Fa flags
One or more of
.Dv PR_URGENT ,
.Dv PR_WAITOK
or
.Dv PR_LIMITFAIL ,
that define behaviour in case the pooled resources are depleted.
The flags can be used to define behaviour in case the pooled resources
are depleted.
If no resources are available and
.Dv PR_WAITOK
.Dv PR_NOWAIT
is given,
this function will wait until items are returned to the pool.
Otherwise
.Fn pool_get
returns
.Dv NULL .
If
.Dv PR_URGENT
is specified and no items are available and
.Fn palloc
cannot allocate a new page,
the system will panic
.Pq XXX .
.Dv PR_WAITOK
is given and allocation is attempted with no resources available,
the function will sleep until items are returned to the pool.
.\"Undefined behaviour results if
.\".Dv PR_MALLOCOK
.\"is specified on a pool handle that was created using client-provided
@ -165,7 +156,7 @@ If both
.Dv PR_LIMITFAIL
and
.Dv PR_WAITOK
is specified, and the pool has reached its hard limit,
are specified, and the pool has reached its hard limit,
.Fn pool_get
will return
.Dv NULL