[src/trunk]: src/share/man/man9 Document kthread_join in kthread(9).

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

details:   https://anonhg.NetBSD.org/src/rev/561cdb629f2f
branches:  trunk
changeset: 754780:561cdb629f2f
user:      haad <haad%NetBSD.org@localhost>
date:      Wed May 12 15:54:47 2010 +0000

description:
Document kthread_join in kthread(9).

diffstat:

 share/man/man9/kthread.9 |  7 ++++++-
 1 files changed, 6 insertions(+), 1 deletions(-)

diffs (35 lines):

diff -r 7b202edbb571 -r 561cdb629f2f share/man/man9/kthread.9
--- a/share/man/man9/kthread.9  Wed May 12 15:53:20 2010 +0000
+++ b/share/man/man9/kthread.9  Wed May 12 15:54:47 2010 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: kthread.9,v 1.20 2009/08/03 23:29:19 rmind Exp $
+.\"     $NetBSD: kthread.9,v 1.21 2010/05/12 15:54:47 haad Exp $
 .\"
 .\" Copyright (c) 2000, 2007, 2008 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -34,6 +34,7 @@
 .Nm kthread_create ,
 .Nm kthread_destroy ,
 .Nm kthread_exit
+.Nm kthread_join
 .Nd kernel threads
 .Sh SYNOPSIS
 .In sys/kthread.h
@@ -108,6 +109,8 @@
 .Fa ci ,
 meaning that it will only ever execute on that CPU.
 By default, the threads are free to execute on any CPU in the system.
+.Dv KTHREAD_JOINABLE
+Request creation of joinable kthread.
 .It Fa func
 A function to be called when the thread begins executing.
 This function must not return.
@@ -139,6 +142,8 @@
 .It Fn kthread_exit "ecode"
 Exit from a kernel thread.
 Must only be called by a kernel thread.
+.It Fn kthread_join "l"
+Suspend execution of running LWP untils the target kthread terminates.
 .El
 .Sh RETURN VALUES
 Upon successful completion,