[src/trunk]: src/share/man/man9 Document the POOL_INIT macro.

[simonb <simonb%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/260655fe0665
branches:  trunk
changeset: 566017:260655fe0665
user:      simonb <simonb%NetBSD.org@localhost>
date:      Sun Apr 25 16:50:56 2004 +0000

description:
Document the POOL_INIT macro.

diffstat:

 share/man/man9/pool.9 |  15 +++++++++++++--
 1 files changed, 13 insertions(+), 2 deletions(-)

diffs (36 lines):

diff -r 6a5554f0d9ee -r 260655fe0665 share/man/man9/pool.9
--- a/share/man/man9/pool.9     Sun Apr 25 16:42:40 2004 +0000
+++ b/share/man/man9/pool.9     Sun Apr 25 16:50:56 2004 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: pool.9,v 1.33 2004/03/24 17:44:22 pooka Exp $
+.\"    $NetBSD: pool.9,v 1.34 2004/04/25 16:50:56 simonb Exp $
 .\"
 .\" Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -34,7 +34,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd March 24, 2004
+.Dd April 25, 2004
 .Dt POOL 9
 .Os
 .Sh NAME
@@ -120,6 +120,17 @@
 .Dv pool_allocator_nointr
 when the pool will never be accessed from interrupt context.
 .El
+.Pp
+The
+.Fn POOL_INIT
+macro can be used to both declare and initialize a resource pool.
+The
+.Fn POOL_INIT
+macro has the same arguments as the
+.Fn pool_init
+function and the resource pool will be initialized automatically
+during system startup.
+.El
 .Ss DESTROYING A POOL
 The function
 .Fn pool_destroy