From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org,
Andrey Smirnov <andrew.smirnov@gmail.com>
Subject: [PATCH 10/10] mfd: si476x-cmd: Update si476x_cmd_am_rsq_status()'s kerneldoc
Date: Thu, 25 Jun 2020 17:31:27 +0100 [thread overview]
Message-ID: <20200625163127.4000462-11-lee.jones@linaro.org> (raw)
In-Reply-To: <20200625163127.4000462-1-lee.jones@linaro.org>
4 of the old arguments were grouped and moved into a struct which
is now passed as a pointer instead of the arguments themselves.
However, whoever carried out this work forgot to update the
function's kerneldoc header.
Fixes the following W=1 warnings:
drivers/mfd/si476x-cmd.c:746: warning: Function parameter or member 'rsqargs' not described in 'si476x_core_cmd_am_rsq_s
drivers/mfd/si476x-cmd.c:746: warning: Excess function parameter 'rsqack' description in 'si476x_core_cmd_am_rsq_status'
drivers/mfd/si476x-cmd.c:746: warning: Excess function parameter 'attune' description in 'si476x_core_cmd_am_rsq_status'
drivers/mfd/si476x-cmd.c:746: warning: Excess function parameter 'cancel' description in 'si476x_core_cmd_am_rsq_status'
drivers/mfd/si476x-cmd.c:746: warning: Excess function parameter 'stcack' description in 'si476x_core_cmd_am_rsq_status'
Cc: Andrey Smirnov <andrew.smirnov@gmail.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/mfd/si476x-cmd.c | 8 ++------
1 file changed, 2 insertions(+), 6 deletions(-)
diff --git a/drivers/mfd/si476x-cmd.c b/drivers/mfd/si476x-cmd.c
index 5b42dfab431a3..0a40c5cb751db 100644
--- a/drivers/mfd/si476x-cmd.c
+++ b/drivers/mfd/si476x-cmd.c
@@ -729,12 +729,8 @@ static int si476x_core_cmd_intb_pin_cfg_a20(struct si476x_core *core,
* si476x_cmd_am_rsq_status - send 'AM_RSQ_STATUS' command to the
* device
* @core: - device to send the command to
- * @rsqack: - if set command clears RSQINT, SNRINT, SNRLINT, RSSIHINT,
- * RSSSILINT, BLENDINT, MULTHINT and MULTLINT
- * @attune: - when set the values in the status report are the values
- * that were calculated at tune
- * @cancel: - abort ongoing seek/tune opertation
- * @stcack: - clear the STCINT bin in status register
+ * @rsqargs: - pointer to a structure containing a group of sub-args
+ * relevant to sending the RSQ status command
* @report: - all signal quality information retured by the command
* (if NULL then the output of the command is ignored)
*
--
2.25.1
prev parent reply other threads:[~2020-06-25 16:31 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-25 16:31 [PATCH 00/10] Fix a yet more W=1 warnings in MFD Lee Jones
2020-06-25 16:31 ` [PATCH 01/10] mfd: cros_ec_dev: Fix cros_feature_to_{name,cells} struct descriptions Lee Jones
2020-06-25 16:35 ` Enric Balletbo i Serra
2020-06-25 16:31 ` [PATCH 02/10] mfd: tps65218: Repair incorrect function argument name 's/tps65218/tps/' Lee Jones
2020-06-25 16:31 ` [PATCH 03/10] mfd: tps65217: Repair incorrect function argument name 's/tps65217/tps/' Lee Jones
2020-06-25 16:31 ` [PATCH 04/10] mfd: ab3100-otp: Add missing colon(s) for all documented kerneldoc arguments Lee Jones
2020-07-07 12:40 ` Linus Walleij
2020-06-25 16:31 ` [PATCH 05/10] mfd: tps65010: Remove delcared and set, but never used variable 'status' Lee Jones
2020-06-25 16:31 ` [PATCH 06/10] mfd: si476x-cmd: Repair wrongly described function argument 's/response/resp' Lee Jones
2020-06-25 16:31 ` [PATCH 07/10] mfd: si476x-cmd: Add missing colon(s) for all documented kerneldoc arguments Lee Jones
2020-06-25 16:31 ` [PATCH 08/10] mfd: si476x-i2c: Add description for si476x_core_fwver_to_revision()'s arg 'func' Lee Jones
2020-06-25 16:31 ` [PATCH 09/10] mfd: si476x-i2c: Fix spelling mistake in case() statement's FALLTHROUGH comment Lee Jones
2020-06-25 16:31 ` Lee Jones [this message]
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=20200625163127.4000462-11-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=andrew.smirnov@gmail.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
/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).