Received: by 2002:a05:6a10:6744:0:0:0:0 with SMTP id w4csp644430pxu; Fri, 23 Oct 2020 09:40:37 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyUsPwhhRheyPXSEmOfod6TGrogK3pBqo2cwM3tYL2v2Q8Ng8qtwIdkmRWnLUZ5fYKIv3+v X-Received: by 2002:a17:906:b197:: with SMTP id w23mr3034341ejy.166.1603471237745; Fri, 23 Oct 2020 09:40:37 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1603471237; cv=none; d=google.com; s=arc-20160816; b=a1EcfLIjZDYtkf1tSrPWJFXOvwHzgeXgcLUzAJpO6uhpCOiEIc1H5Gqo4IE7qlFQ+w W47Tgi+TIsPXx7aG/o9zCXczQ9j1KOMwenqOtVTIdwlvywEy3OdCWxd23yddGHVF0sM0 bmKOxQo5MaLS4E1TzrlFqRPln9Zxm0mhyBBhdGooNvUUMxh28DToABZ/plnsspdBoD90 gYnN8ts298J6VGnmUZa2elodDwtwmJb+lWOQ1+x1+Os6jc5jc7YDtTxN4XG2DS4hg4Zy lxl7dyy0NJeBUDaO8ZSG29QrsQLuDt3nNKcIEdHNst8xiMxRY0o6KvVXdfcgFY/4bns1 1ztQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=nKU9uXMbosc1RgF4tZuVKYbfOOKFQ5BblRMZd3Y2MgA=; b=j6GbZ4Uy13GlfRcQ8sA83DPeMyd/USRzQ9eAfNFREtMZDLmkkBgMNQSExToArC3jl0 vGrkoHZUskyeHeVM6W3zg5NB0zOHuxOSjOfW5enMouldnnKAeN3IkPTsqq6/I0aBtBXm ziWQPcC8rW3mJCba68R/CY9dEdfP1IszgNAOVhW90HC4bknUjOATtp8EQQGXRO9UxI9Q MV4iMJFa7kfBDtDWafbz1KbKi2L7bU66yZYFEMaguuZOcGhZy0LymoB0Il6eh1WHSVKw f8tA0CxuRZb7/iQ5rc8Csm2uoONIDhzPPh7tGG2MT4bWDxYBKqtDRerUbS2hGwsCY8EW mJOg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=hA1AFJoV; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id s2si1215514eju.121.2020.10.23.09.40.15; Fri, 23 Oct 2020 09:40:37 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=hA1AFJoV; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751832AbgJWQdt (ORCPT + 99 others); Fri, 23 Oct 2020 12:33:49 -0400 Received: from mail.kernel.org ([198.145.29.99]:60972 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S460729AbgJWQdr (ORCPT ); Fri, 23 Oct 2020 12:33:47 -0400 Received: from mail.kernel.org (ip5f5ad5a3.dynamic.kabel-deutschland.de [95.90.213.163]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id DF876208C3; Fri, 23 Oct 2020 16:33:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1603470827; bh=jqnFAPsIfCGcK4EmZia0M9yZrQtemKpIJgvWitRa3Vg=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=hA1AFJoVKGlISkeveViqf6CWXGyJh0elExzT2kuY+N5RE+wZt6QdJ9h8nzQ4WgSB2 Rh+J7XFhJwqBGteqo1wOQ2wae/PaDbDgIrjqPguDx70QnLjeMTaC3XDJY5vcbl4qBB D/6W+kTO/uyI6yykN6BG0Oc/grQ3g1MvCvy5gxOA= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kW00e-002Avf-Ur; Fri, 23 Oct 2020 18:33:44 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , "Rafael J. Wysocki" , Greg Kroah-Hartman , Luis Chamberlain , linux-kernel@vger.kernel.org Subject: [PATCH v3 09/56] drivers: base: fix some kernel-doc markups Date: Fri, 23 Oct 2020 18:32:56 +0200 Message-Id: <2fb6efd6a1f90d69ff73bf579566079cbb051e15.1603469755.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org class_create is actually defined at the header. Fix the markup there and add a new one at the right place. While here, also fix some markups for functions that have different names between their prototypes and kernel-doc comments. Signed-off-by: Mauro Carvalho Chehab --- drivers/base/class.c | 2 +- drivers/base/devres.c | 2 +- drivers/base/firmware_loader/fallback.c | 2 +- include/linux/device/class.h | 14 ++++++++++++++ 4 files changed, 17 insertions(+), 3 deletions(-) diff --git a/drivers/base/class.c b/drivers/base/class.c index c3451481194e..7476f393df97 100644 --- a/drivers/base/class.c +++ b/drivers/base/class.c @@ -210,7 +210,7 @@ static void class_create_release(struct class *cls) } /** - * class_create - create a struct class structure + * __class_create - create a struct class structure * @owner: pointer to the module that is to "own" this struct class * @name: pointer to a string for the name of this class. * @key: the lock_class_key for this class; used by mutex lock debugging diff --git a/drivers/base/devres.c b/drivers/base/devres.c index 586e9a75c840..fb9d5289a620 100644 --- a/drivers/base/devres.c +++ b/drivers/base/devres.c @@ -149,7 +149,7 @@ void * __devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, int nid EXPORT_SYMBOL_GPL(__devres_alloc_node); #else /** - * devres_alloc - Allocate device resource data + * devres_alloc_node - Allocate device resource data * @release: Release function devres will be associated with * @size: Allocation size * @gfp: Allocation flags diff --git a/drivers/base/firmware_loader/fallback.c b/drivers/base/firmware_loader/fallback.c index 4dec4b79ae06..91899d185e31 100644 --- a/drivers/base/firmware_loader/fallback.c +++ b/drivers/base/firmware_loader/fallback.c @@ -128,7 +128,7 @@ static ssize_t timeout_show(struct class *class, struct class_attribute *attr, } /** - * firmware_timeout_store() - set number of seconds to wait for firmware + * timeout_store() - set number of seconds to wait for firmware * @class: device class pointer * @attr: device attribute pointer * @buf: buffer to scan for timeout value diff --git a/include/linux/device/class.h b/include/linux/device/class.h index e8d470c457d1..e61ec5502019 100644 --- a/include/linux/device/class.h +++ b/include/linux/device/class.h @@ -256,6 +256,20 @@ extern void class_destroy(struct class *cls); /* This is a #define to keep the compiler from merging different * instances of the __key variable */ + +/** + * class_create - create a struct class structure + * @owner: pointer to the module that is to "own" this struct class + * @name: pointer to a string for the name of this class. + * + * This is used to create a struct class pointer that can then be used + * in calls to device_create(). + * + * Returns &struct class pointer on success, or ERR_PTR() on error. + * + * Note, the pointer created here is to be destroyed when finished by + * making a call to class_destroy(). + */ #define class_create(owner, name) \ ({ \ static struct lock_class_key __key; \ -- 2.26.2