Document dt(4)'s refcnt_init_trace
authorkn <kn@openbsd.org>
Thu, 6 Jul 2023 20:51:31 +0000 (20:51 +0000)
committerkn <kn@openbsd.org>
Thu, 6 Jul 2023 20:51:31 +0000 (20:51 +0000)
"yes please" mvs
Input jca

share/man/man9/refcnt_init.9

index 22bf643..816a85a 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: refcnt_init.9,v 1.3 2022/04/30 14:44:04 visa Exp $
+.\"    $OpenBSD: refcnt_init.9,v 1.4 2023/07/06 20:51:31 kn Exp $
 .\"
 .\" Copyright (c) 2015 David Gwynne <dlg@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: April 30 2022 $
+.Dd $Mdocdate: July 6 2023 $
 .Dt REFCNT_INIT 9
 .Os
 .Sh NAME
@@ -32,6 +32,8 @@
 .Ft void
 .Fn "refcnt_init" "struct refcnt *r"
 .Ft void
+.Fn "refcnt_init_trace" "struct refcnt *r" "int idx"
+.Ft void
 .Fn "refcnt_take" "struct refcnt *r"
 .Ft int
 .Fn "refcnt_rele" "struct refcnt *r"
@@ -51,6 +53,10 @@ to manage the lifetime of a shared object.
 .Fn refcnt_init
 sets the initial value of the counter to 1 to account for the caller's
 reference to the object.
+.Fn refcnt_init_trace
+additionally accepts a
+.Xr dt 4
+static probe index.
 .Pp
 .Fn refcnt_take
 is used to acquire a new reference.
@@ -99,6 +105,7 @@ whenever possible.
 initialises a declaration of a refcnt to 1.
 .Sh CONTEXT
 .Fn refcnt_init ,
+.Fn refcnt_init_trace ,
 .Fn refcnt_take ,
 .Fn refcnt_rele ,
 .Fn refcnt_rele_wake ,