Source-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[src/trunk]: src/share/man/man9 Document also rest of the functions.



details:   https://anonhg.NetBSD.org/src/rev/4f3d4546e641
branches:  trunk
changeset: 751147:4f3d4546e641
user:      jruoho <jruoho%NetBSD.org@localhost>
date:      Tue Jan 26 07:53:25 2010 +0000

description:
Document also rest of the functions.

diffstat:

 share/man/man9/sysmon_taskq.9 |  18 +++++++++++++++++-
 1 files changed, 17 insertions(+), 1 deletions(-)

diffs (39 lines):

diff -r d8bb6b573c1f -r 4f3d4546e641 share/man/man9/sysmon_taskq.9
--- a/share/man/man9/sysmon_taskq.9     Tue Jan 26 07:16:41 2010 +0000
+++ b/share/man/man9/sysmon_taskq.9     Tue Jan 26 07:53:25 2010 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: sysmon_taskq.9,v 1.3 2010/01/26 07:12:06 jruoho Exp $
+.\" $NetBSD: sysmon_taskq.9,v 1.4 2010/01/26 07:53:25 jruoho Exp $
 .\"
 .\" Copyright (c) 2010 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -35,6 +35,12 @@
 .Nd general purpose system monitoring task queue
 .Sh SYNOPSIS
 .In dev/sysmon/sysmon_taskq.h
+.Ft void
+.Fn sysmon_task_queue_preinit "void"
+.Ft void
+.Fn sysmon_task_queue_init "void"
+.Ft void
+.Fn sysmon_task_queue_fini "void"
 .Ft int
 .Fn sysmon_task_queue_sched "u_int pri" "void (*func)(void *)" "void *arg"
 .Sh DESCRIPTION
@@ -47,6 +53,16 @@
 Although the intended usage is related to the context of system monitoring
 and power management, also other comparable functions are suitable for
 .Nm .
+.Sh FUNCTIONS
+The necessary internal data structures
+are initialized during system startup by
+.Fn sysmon_task_queue_preinit .
+Before actual usage, a machine-independent
+procedure should finish the initialization
+by calling
+.Fn sysmon_task_queue_init .
+This will create a kernel thread that can be later halted by
+.Fn sysmon_task_queue_fini .
 .Pp
 The
 .Fn sysmon_task_queue_sched



Home | Main Index | Thread Index | Old Index