diff mbox

kthread: add kerneldoc for kthread_create()

Message ID 20160826072313.726a3485@lwn.net
State Accepted
Commit e154ccc831b5b52a9aa3fe881090bdaf1d80f062
Headers show

Commit Message

Jonathan Corbet Aug. 26, 2016, 1:23 p.m. UTC 
This macro is referenced in other kerneldoc comments, but lacks one of its
own; fix that.

Reported-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

---
 include/linux/kthread.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

-- 
2.7.4
diff mbox

Patch

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)