update to match with the recent reality.

This commit is contained in:
yamt 2008-05-06 11:32:46 +00:00
parent c331e3e5e9
commit 9cbf394e66
2 changed files with 24 additions and 23 deletions

View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.263 2008/05/06 08:34:35 yamt Exp $
# $NetBSD: Makefile,v 1.264 2008/05/06 11:32:46 yamt Exp $
# Makefile for section 9 (kernel function and variable) manual pages.
@ -250,8 +250,7 @@ MLINKS+=fstrans.9 fstrans_done.9 \
fstrans.9 fscow_establish.9 \
fstrans.9 fscow_disestablish.9 \
fstrans.9 fscow_run.9
MLINKS+=getiobuf.9 getiobuf_nowait.9 \
getiobuf.9 putiobuf.9
MLINKS+=getiobuf.9 putiobuf.9
MLINKS+=hash.9 hash32_buf.9 hash.9 hash32_str.9 hash.9 hash32_strn.9
MLINKS+=hashinit.9 hashdone.9
MLINKS+=humanize_number.9 format_bytes.9

View File

@ -1,6 +1,6 @@
.\" $NetBSD: getiobuf.9,v 1.2 2006/01/17 00:02:19 wiz Exp $
.\" $NetBSD: getiobuf.9,v 1.3 2008/05/06 11:32:47 yamt Exp $
.\"
.\" Copyright (c)2006 YAMAMOTO Takashi,
.\" Copyright (c)2006,2008 YAMAMOTO Takashi,
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@ -24,21 +24,18 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\" ------------------------------------------------------------
.Dd January 17, 2006
.Dd May 6, 2008
.Dt GETIOBUF 9
.Os
.Sh NAME
.Nm getiobuf ,
.Nm getiobuf_nowait ,
.Nm putiobuf
.Nd I/O descriptor allocation interface
.\" ------------------------------------------------------------
.Sh SYNOPSIS
.In sys/buf.h
.Ft struct buf *
.Fn getiobuf "void"
.Ft struct buf *
.Fn getiobuf_nowait "void"
.Fn getiobuf "struct vnode *vp" "bool waitok"
.Ft void
.Fn putiobuf "struct buf *bp"
.\" ------------------------------------------------------------
@ -49,7 +46,22 @@
allocates a
.Em buf
structure.
Note that this buffer doesn't belong to buffer cache.
.Pp
.Bl -tag -width waitok
.It Fa vp
The vnode to which the allocated buffer will be associated.
This can be
.Dv NULL .
.It Fa waitok
If true,
.Fa getiobuf
can sleep until enough memory is available.
Otherwise, it returns
.Dv NULL
immediately if enough memory is not available.
.El
.Pp
Note that the allocated buffer doesn't belong to buffer cache.
To free it,
.Fn putiobuf
should be used.
@ -57,21 +69,11 @@ should be used.
should not be used on it.
.Pp
.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.Fn getiobuf_nowait
is the same as
.Fn getiobuf ,
except that
.Fn getiobuf_nowait
never sleeps.
.Pp
.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.Fn putiobuf
frees
.Fa bp ,
which should be a buffer allocated with either of
.Fn getiobuf
or
.Fn getiobuf_nowait .
which should be a buffer allocated with
.Fn getiobuf .
.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.El
.\" ------------------------------------------------------------