linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, stable@vger.kernel.org,
	Thor Thayer <thor.thayer@linux.intel.com>
Subject: [PATCH 10/10] mfd: altera-sysmgr: Supply descriptions for 'np' and 'property' function args
Date: Thu, 25 Jun 2020 07:46:19 +0100	[thread overview]
Message-ID: <20200625064619.2775707-11-lee.jones@linaro.org> (raw)
In-Reply-To: <20200625064619.2775707-1-lee.jones@linaro.org>

Kerneldoc syntax is used, but not complete.  Arg descriptions are required.

Fixes the following W=1 build warnings:

 drivers/mfd/altera-sysmgr.c:95: warning: Function parameter or member 'np' not described in 'altr_sysmgr_regmap_lookup_by_phandle'
 drivers/mfd/altera-sysmgr.c:95: warning: Function parameter or member 'property' not described in 'altr_sysmgr_regmap_lookup_by_phandle'

Cc: <stable@vger.kernel.org>
Cc: Thor Thayer <thor.thayer@linux.intel.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mfd/altera-sysmgr.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/drivers/mfd/altera-sysmgr.c b/drivers/mfd/altera-sysmgr.c
index 83f0765f819b0..41076d121dd54 100644
--- a/drivers/mfd/altera-sysmgr.c
+++ b/drivers/mfd/altera-sysmgr.c
@@ -89,6 +89,9 @@ static struct regmap_config altr_sysmgr_regmap_cfg = {
  * altr_sysmgr_regmap_lookup_by_phandle
  * Find the sysmgr previous configured in probe() and return regmap property.
  * Return: regmap if found or error if not found.
+ *
+ * @np: Pointer to device's Device Tree node
+ * @property: Device Tree property name which references the sysmgr
  */
 struct regmap *altr_sysmgr_regmap_lookup_by_phandle(struct device_node *np,
 						    const char *property)
-- 
2.25.1


  parent reply	other threads:[~2020-06-25  6:46 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-25  6:46 [PATCH 00/10] Fix a bunch more W=1 warnings in MFD Lee Jones
2020-06-25  6:46 ` [PATCH 01/10] mfd: wm8350-core: Supply description wm8350_reg_{un}lock args Lee Jones
2020-06-25  6:56   ` Greg KH
2020-06-25  7:13     ` Lee Jones
2020-06-25  9:45       ` Greg KH
2020-06-25 13:34         ` Lee Jones
2020-06-25 13:24       ` Jonathan Corbet
2020-06-25 13:38         ` Lee Jones
2020-06-25  6:46 ` [PATCH 02/10] mfd: mfd-core: Complete kerneldoc header for devm_mfd_add_devices() Lee Jones
2020-07-01 19:33   ` Sasha Levin
2020-07-02  6:36     ` Lee Jones
2020-07-10 14:02   ` Sasha Levin
2020-06-25  6:46 ` [PATCH 03/10] mfd: db8500-prcmu: Add description for 'reset_reason' in kerneldoc Lee Jones
2020-07-07 12:39   ` Linus Walleij
2020-06-25  6:46 ` [PATCH 04/10] mfd: db8500-prcmu: Remove incorrect function header from .probe() function Lee Jones
2020-07-07 12:39   ` Linus Walleij
2020-06-25  6:46 ` [PATCH 05/10] mfd: omap-usb-host: Remove invalid use of kerneldoc syntax Lee Jones
2020-06-25  6:46 ` [PATCH 06/10] mfd: omap-usb-host: Provide description for 'pdev' argument to .probe() Lee Jones
2020-06-25  6:46 ` [PATCH 07/10] mfd: omap-usb-tll: " Lee Jones
2020-06-25  6:46 ` [PATCH 08/10] mfd: atmel-smc: Silence comparison of unsigned expression < 0 is always false warning (W=1) Lee Jones
2020-06-26 20:56   ` Alexandre Belloni
2020-06-30 12:10     ` Lee Jones
2020-06-25  6:46 ` [PATCH 09/10] mfd: atmel-smc: Add missing colon(s) for 'conf' arguments Lee Jones
2020-06-25  6:55   ` Greg KH
2020-06-26 20:56   ` Alexandre Belloni
2020-07-01 19:33   ` Sasha Levin
2020-07-02  6:36     ` Lee Jones
2020-07-10 14:02   ` Sasha Levin
2020-06-25  6:46 ` Lee Jones [this message]
2020-07-01 19:33   ` [PATCH 10/10] mfd: altera-sysmgr: Supply descriptions for 'np' and 'property' function args Sasha Levin
2020-07-02  6:35     ` Lee Jones
2020-07-10 14:02   ` Sasha Levin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200625064619.2775707-11-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=stable@vger.kernel.org \
    --cc=thor.thayer@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).