From patchwork Fri Aug 26 13:23:13 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 74794 Delivered-To: patch@linaro.org Received: by 10.140.29.52 with SMTP id a49csp359936qga; Fri, 26 Aug 2016 06:55:23 -0700 (PDT) X-Received: by 10.66.88.131 with SMTP id bg3mr6285434pab.43.1472219723557; Fri, 26 Aug 2016 06:55:23 -0700 (PDT) Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id pe4si21346777pac.256.2016.08.26.06.55.23; Fri, 26 Aug 2016 06:55:23 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752930AbcHZNzU (ORCPT + 27 others); 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 Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by vena.lwn.net (Postfix) with ESMTP id 35615154003C; Fri, 26 Aug 2016 07:23:15 -0600 (MDT) 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 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk 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(+) -- 2.7.4 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)