Module Name: src
Committed By: wiz
Date: Thu May 13 09:56:12 UTC 2010
Modified Files:
src/share/man/man9: kthread.9
Log Message:
Put flags into a list. Bug fixes to kthread_join docs.
To generate a diff of this commit:
cvs rdiff -u -r1.21 -r1.22 src/share/man/man9/kthread.9
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man9/kthread.9
diff -u src/share/man/man9/kthread.9:1.21 src/share/man/man9/kthread.9:1.22
--- src/share/man/man9/kthread.9:1.21 Wed May 12 15:54:47 2010
+++ src/share/man/man9/kthread.9 Thu May 13 09:56:12 2010
@@ -1,4 +1,4 @@
-.\" $NetBSD: kthread.9,v 1.21 2010/05/12 15:54:47 haad Exp $
+.\" $NetBSD: kthread.9,v 1.22 2010/05/13 09:56:12 wiz Exp $
.\"
.\" Copyright (c) 2000, 2007, 2008 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -27,13 +27,13 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd August 3, 2009
+.Dd May 12, 2010
.Dt KTHREAD 9
.Os
.Sh NAME
.Nm kthread_create ,
.Nm kthread_destroy ,
-.Nm kthread_exit
+.Nm kthread_exit ,
.Nm kthread_join
.Nd kernel threads
.Sh SYNOPSIS
@@ -67,26 +67,23 @@
to select the default priority level.
.It Fa flags
Flags that can be logically ORed together to alter the thread's behaviour.
-.Pp
-.Dv KTHREAD_IDLE :
-causes the thread to be created in the
+.Bl -tag -width KTHREAD_JOINABLE
+.It Dv KTHREAD_IDLE
+Causes the thread to be created in the
.Dv LSIDL
(idle) state.
By default, the threads are created in the
.Dv LSRUN
(runnable) state, meaning they will begin execution shortly after creation.
-.Pp
-.Dv KTHREAD_MPSAFE :
+.It Dv KTHREAD_MPSAFE
Specifies that the thread does its own locking and so is multiprocessor safe.
If not specified, the global kernel lock will be held whenever the thread is
running (unless explicitly dropped by the thread).
-.Pp
-.Dv KTHREAD_INTR :
+.It Dv KTHREAD_INTR
Specifies that the thread services device interrupts.
This flag is intended for kernel internal use and should not normally be
specified.
-.Pp
-.Dv KTHREAD_TS :
+.It Dv KTHREAD_TS
Causes the kthread to be created in the
.Dv SCHED_OTHER
class (timeshared).
@@ -102,6 +99,9 @@
.Dv SCHED_RR
class do not have their priority dynamically
adjusted by the scheduler.
+.It Dv KTHREAD_JOINABLE
+Request creation of joinable kthread.
+.El
.It Fa ci
If
.No non- Ns Dv NULL ,
@@ -109,8 +109,6 @@
.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.
@@ -143,7 +141,7 @@
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.
+Suspend execution of the LWP until the target kthread terminates.
.El
.Sh RETURN VALUES
Upon successful completion,
