aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChad David <davidc@FreeBSD.org>2002-04-12 05:55:17 +0000
committerChad David <davidc@FreeBSD.org>2002-04-12 05:55:17 +0000
commit57cf9551719f2bc4d4e4409f0e346d5a2165ef06 (patch)
treea6b537df3b5f544dd536de362c03c0b34852b1e5
parent7344c0a1941ae407064e733cda3f812e6ef758b2 (diff)
Notes
-rw-r--r--share/man/man9/mutex.923
1 files changed, 17 insertions, 6 deletions
diff --git a/share/man/man9/mutex.9 b/share/man/man9/mutex.9
index 5003b9434078c..5674b0f42d4ea 100644
--- a/share/man/man9/mutex.9
+++ b/share/man/man9/mutex.9
@@ -56,7 +56,7 @@
.In sys/lock.h
.In sys/mutex.h
.Ft void
-.Fn mtx_init "struct mtx *mutex" "const char *description" "const char *type" "int opts"
+.Fn mtx_init "struct mtx *mutex" "const char *name" "const char *type" "int opts"
.Ft void
.Fn mtx_lock "struct mtx *mutex"
.Ft void
@@ -144,11 +144,22 @@ function must be used to initialize a mutex
before it can be passed to
.Fn mtx_lock .
The
-.Fa description
-argument is used by the witness code
-to classify a mutex when doing checks of lock ordering.
-The pointer passed in as the
-.Fa description
+.Fa name
+option is used to identify the lock in debugging output etc.
+The
+.Fa type
+option is used by the witness code to classify a mutex when doing checks
+of lock ordering.
+If
+.Fa type
+is
+.Dv NULL ,
+.Fa name
+is used in its place.
+The pointer passed in as
+.Fa name
+and
+.Fa type
is saved rather than the data it points to.
The data pointed to must remain stable
until the mutex is destroyed.