[src/netbsd-3]: src/share/man/man9 Pull up following revision(s) (requested b...

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

details:   https://anonhg.NetBSD.org/src/rev/dbafa930946d
branches:  netbsd-3
changeset: 577150:dbafa930946d
user:      tron <tron%NetBSD.org@localhost>
date:      Mon Sep 12 12:30:25 2005 +0000

description:
Pull up following revision(s) (requested by briggs in ticket #759):
        share/man/man9/kthread.9: revision 1.13
Mention that a kthread *must* call kthread_exit() to terminate itself
properly.  If you don't, the kernel will likely crash.

diffstat:

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

diffs (32 lines):

diff -r d08779cd68bc -r dbafa930946d share/man/man9/kthread.9
--- a/share/man/man9/kthread.9  Mon Sep 12 12:26:27 2005 +0000
+++ b/share/man/man9/kthread.9  Mon Sep 12 12:30:25 2005 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: kthread.9,v 1.12 2004/04/23 02:58:27 simonb Exp $
+.\"     $NetBSD: kthread.9,v 1.12.2.1 2005/09/12 12:30:25 tron Exp $
 .\"
 .\" Copyright (c) 2000 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -57,6 +57,9 @@
 Any process can request the creation of a new kernel thread.
 Kernel threads are not swapped out during memory congestion.
 The VM space and limits are shared with proc0 (usually swapper).
+A kernel thread must call
+.Fn kthread_exit
+to end execution.
 .Sh FUNCTIONS
 .Bl -tag -width compact
 .It Fn kthread_create1 "void (*func)(void *)" "void *arg" "struct proc **newpp" "const char *fmt" "..."
@@ -71,6 +74,12 @@
 .Fa fmt
 is a string containing format information used to display the kernel
 thread name.
+The function
+.Fa func
+must not return.
+If the kernel thread runs to completion, it must call
+.Fn kthread_exit
+to properly terminate itself.
 .It Fn kthread_create "void (*func)(void *)" "void *arg"
 Register function
 .Fa func