docs/120357: [patch] style.9 - document also the _arg versions of the uma_zalloc and uma_zfree functions

[Pietro Cerutti]

>Number:         120357
>Category:       docs
>Synopsis:       [patch] style.9 - document also the _arg versions of the uma_zalloc and uma_zfree functions
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Thu Feb 07 17:40:01 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator:     Pietro Cerutti
>Release:        FreeBSD 8.0-CURRENT i386
>Organization:
>Environment:


System: FreeBSD 8.0-CURRENT #3: Thu Feb  7 17:04:34 CET 2008
    root at gahrtop.localhost:/usr/obj/usr/src/sys/MSI1034



>Description:





>How-To-Repeat:





>Fix:


--- _zone.9.diff begins here ---
--- zone.9.orig	2008-02-07 18:12:31.000000000 +0100
+++ zone.9	2008-02-07 18:30:46.000000000 +0100
@@ -31,7 +31,9 @@
 .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 @@
 .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
--- _zone.9.diff ends here ---



>Release-Note:
>Audit-Trail:
>Unformatted: