1
0
mirror of https://git.FreeBSD.org/src.git synced 2024-11-23 07:31:31 +00:00

Document the _arg versions of the uma_zalloc and uma_zfree functions.

PR:		docs/120357
Submitted by:	gahr
MFC after:	3 days
This commit is contained in:
Remko Lodder 2008-06-19 18:33:38 +00:00
parent 23c8064e66
commit 6a4c41d1bb
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=179880

View File

@ -25,13 +25,15 @@
.\"
.\" $FreeBSD$
.\"
.Dd October 2, 2006
.Dd June 19, 2008
.Dt ZONE 9
.Os
.Sh NAME
.Nm uma_zcreate ,
.Nm uma_zalloc ,
.Nm uma_zalloc_arg ,
.Nm uma_zfree ,
.Nm uma_zfree_arg ,
.Nm uma_zdestroy ,
.Nm uma_zone_set_max
.Nd zone allocator
@ -47,9 +49,13 @@
.Fc
.Ft "void *"
.Fn uma_zalloc "uma_zone_t zone" "int flags"
.Ft "void *"
.Fn uma_zalloc_arg "uma_zone_t zone" "void *arg" "int flags"
.Ft void
.Fn uma_zfree "uma_zone_t zone" "void *item"
.Ft void
.Fn uma_zfree_arg "uma_zone_t zone" "void *item" "void *arg"
.Ft void
.Fn uma_zdestroy "uma_zone_t zone"
.Ft void
.Fn uma_zone_set_max "uma_zone_t zone" "int nitems"
@ -142,6 +148,17 @@ calling
.Fn uma_zfree
with a pointer to the zone and a pointer to the item.
.Pp
The variations
.Fn uma_zalloc_arg
and
.Fn uma_zfree_arg
allow to
specify an argument for the
.Dv ctor
and
.Dv dtor
functions, respectively.
.Pp
Created zones,
which are empty,
can be destroyed using