Module Name: src
Committed By: riastradh
Date: Mon Sep 7 01:07:38 UTC 2020
Modified Files:
src/share/man/man9: threadpool.9
Log Message:
threadpool: Fix man page for threadpool_job_init.
This is threadpool_job_init(job, fn, interlock, fmt, args...), not
just threadpool_job_init(job, fn, interlock).
To generate a diff of this commit:
cvs rdiff -u -r1.3 -r1.4 src/share/man/man9/threadpool.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/threadpool.9
diff -u src/share/man/man9/threadpool.9:1.3 src/share/man/man9/threadpool.9:1.4
--- src/share/man/man9/threadpool.9:1.3 Wed Dec 26 21:48:55 2018
+++ src/share/man/man9/threadpool.9 Mon Sep 7 01:07:38 2020
@@ -1,4 +1,4 @@
-.\" $NetBSD: threadpool.9,v 1.3 2018/12/26 21:48:55 thorpej Exp $
+.\" $NetBSD: threadpool.9,v 1.4 2020/09/07 01:07:38 riastradh Exp $
.\"
.\" Copyright (c) 2014 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -59,7 +59,7 @@
.Fn threadpool_percpu_ref_remote "struct threadpool_percpu *pool" "struct cpu_info *ci"
.\""""""""""""""""""""""""""""""""""""
.Ft void
-.Fn threadpool_job_init "struct threadpool_job *job" "threadpool_job_fn_t fn" "kmutex_t *interlock"
+.Fn threadpool_job_init "struct threadpool_job *job" "threadpool_job_fn_t fn" "kmutex_t *interlock" "const char *fmt" "..."
.\"
.Ft void
.Fn threadpool_job_destroy "struct threadpool_job *job"
@@ -214,13 +214,18 @@ Do not use
with thread pools obtained from
.Fn threadpool_percpu_ref_remote .
.\""""""""""""""""""""""""""""""""""""
-.It Fn threadpool_job_init "job" "fn" "interlock"
+.It Fn threadpool_job_init "job" "fn" "interlock" "fmt" "..."
Initialize the threadpool job
.Fa job
to run
.Fa fn
when scheduled and to interlock with
.Fa interlock .
+The argument
+.Fa fmt
+is a
+.Xr printf 9
+format string for the job's name.
.Pp
The mutex
.Fa interlock
