diff options
| author |   Jonathan Corbet <corbet@lwn.net> | 2016-10-11 13:55:53 -0700 |
|---|---|---|
| committer |   Linus Torvalds <torvalds@linux-foundation.org> | 2016-10-11 15:06:33 -0700 |
| commit | e154ccc831b5b52a9aa3fe881090bdaf1d80f062 (patch) | |
| tree | 7a2e1454a29723c0a63b97eff7987360a9f2c2a6 /include | |
| parent | kthread: better support freezable kthread workers (diff) | |
| download | linux-dev-e154ccc831b5b52a9aa3fe881090bdaf1d80f062.tar.xz linux-dev-e154ccc831b5b52a9aa3fe881090bdaf1d80f062.zip | |
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>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'include')
| -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 4f5235cb13bb..a6e82a69c363 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) |