Module Name: src
Committed By: jruoho
Date: Tue Jan 26 07:53:25 UTC 2010
Modified Files:
src/share/man/man9: sysmon_taskq.9
Log Message:
Document also rest of the functions.
To generate a diff of this commit:
cvs rdiff -u -r1.3 -r1.4 src/share/man/man9/sysmon_taskq.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/sysmon_taskq.9
diff -u src/share/man/man9/sysmon_taskq.9:1.3 src/share/man/man9/sysmon_taskq.9:1.4
--- src/share/man/man9/sysmon_taskq.9:1.3 Tue Jan 26 07:12:06 2010
+++ src/share/man/man9/sysmon_taskq.9 Tue Jan 26 07:53:25 2010
@@ -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
