From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752929AbcHZNzU (ORCPT ); Fri, 26 Aug 2016 09:55:20 -0400 Received: from tex.lwn.net ([70.33.254.29]:39541 "EHLO vena.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751085AbcHZNzT (ORCPT ); Fri, 26 Aug 2016 09:55:19 -0400 Date: Fri, 26 Aug 2016 07:23:13 -0600 From: Jonathan Corbet To: Andrew Morton Cc: LKML , Mauro Carvalho Chehab Subject: [PATCH] kthread: add kerneldoc for kthread_create() Message-ID: <20160826072313.726a3485@lwn.net> Organization: LWN.net X-Mailer: Claws Mail 3.13.2 (GTK+ 2.24.30; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This macro is referenced in other kerneldoc comments, but lacks one of its own; fix that. Reported-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet --- include/linux/kthread.h | 11 +++++++++++ 1 file changed, 11 insertions(+) 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) -- 2.7.4