d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add text describing the new type parameter, and rename description

Browse Source 
to name as that is what it is called in mutex.h.
This commit is contained in:
Chad David 2002-04-12 05:55:17 +00:00
parent 7344c0a194
commit 57cf955171
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
share/man/man9/mutex.9
View File

@ -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.