diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2016-09-20 10:11:04 +1000 |
|---|---|---|
| committer | Stephen Rothwell <sfr@canb.auug.org.au> | 2016-09-20 17:27:17 +1000 |
| commit | 990be615888bb56af43ec0563fc3737905d1e1cd (patch) | |
| tree | 89bd49b5e2f1e11ca8667f7a76c3709f71210acc | |
| parent | 80fbe1a1d4f1b90b3230f4cd1165efb2fa23930e (diff) | |
| download | linux-next-990be615888bb56af43ec0563fc3737905d1e1cd.tar.gz | |
kthread: add kerneldoc for kthread_create()
This macro is referenced in other kerneldoc comments, but lacks one of its
own; fix that.
Link: http://lkml.kernel.org/r/20160826072313.726a3485@lwn.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Reported-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
| -rw-r--r-- | include/linux/kthread.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/include/linux/kthread.h b/include/linux/kthread.h index e691b6a23f72..489c697f44b7 100644 --- a/include/linux/kthread.h +++ b/include/linux/kthread.h @@ -10,6 +10,17 @@ struct task_struct *kthread_create_on_node(int (*threadfn)(void *data), int node, const char namefmt[], ...); +/** + * kthread_create - create a kthread on the current node + * @threadfn: the function to run in the thread + * @data: data pointer for @threadfn() + * @namefmt: printf-style format string for the thread name + * @...: arguments for @namefmt. + * + * This macro will create a kthread on the current node, leaving it in + * the stopped state. This is just a helper for kthread_create_on_node(); + * see the documentation there for more details. + */ #define kthread_create(threadfn, data, namefmt, arg...) \ kthread_create_on_node(threadfn, data, NUMA_NO_NODE, namefmt, ##arg) |