From: Venkatesh Srinivas <me@endeavour.zapto.org>
Date: Mon, 10 Oct 2011 02:29:54 +0000 (-0700)
Subject: Document spin_pool_lock(9) and spin_pool_unlock(9).
X-Git-Tag: v3.0.0~875
X-Git-Url: https://gitweb.dragonflybsd.org/dragonfly.git/commitdiff_plain/01c7831a49dadb5469022e40b96436df9d1a2695?ds=sidebyside

Document spin_pool_lock(9) and spin_pool_unlock(9).
---

diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 514ecff14e..6a52431d60 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -796,7 +796,9 @@ MLINKS+=spinlock.9 spin_init.9 \
 	spinlock.9 spin_trylock.9 \
 	spinlock.9 spin_uninit.9 \
 	spinlock.9 spin_unlock.9 \
-	spinlock.9 spin_unlock_quick.9
+	spinlock.9 spin_unlock_quick.9 \
+	spinlock.9 spin_pool_lock.9 \
+	spinlock.9 spin_pool_unlock.9
 MLINKS+=store.9 casuword.9 \
 	store.9 subyte.9 \
 	store.9 susword.9 \
diff --git a/share/man/man9/spinlock.9 b/share/man/man9/spinlock.9
index bd5fbdf875..d847f93351 100644
--- a/share/man/man9/spinlock.9
+++ b/share/man/man9/spinlock.9
@@ -38,7 +38,9 @@
 .Nm spin_trylock ,
 .Nm spin_uninit ,
 .Nm spin_unlock ,
-.Nm spin_unlock_quick
+.Nm spin_unlock_quick ,
+.Nm spin_pool_lock ,
+.Nm spin_pool_unlock
 .Nd core spinlocks
 .Sh SYNOPSIS
 .In sys/spinlock.h
@@ -101,6 +103,15 @@ A previously obtained exclusive spinlock is released by calling either
 .Fn spin_unlock
 or
 .Fn spin_unlock_quick .
+.Pp
+The
+.Fn spin_pool_lock
+function locks a pool spinlock associated with a given address. The spinlock's 
+lifetime is not tied to any objects at the address. The function returns the
+locked spinlock. The 
+.Fn spin_pool_unlock
+function unlocks a pool spinlock associated with an address. Pool spinlocks
+need not be initialized.
 .Sh IMPLEMENTATION NOTES
 A thread may not hold any spinlock across a blocking condition or
 thread switch.