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,
	Andrey Smirnov <andrew.smirnov@gmail.com>
Subject: [PATCH 06/10] mfd: si476x-cmd: Repair wrongly described function argument 's/response/resp'
Date: Thu, 25 Jun 2020 17:31:23 +0100	[thread overview]
Message-ID: <20200625163127.4000462-7-lee.jones@linaro.org> (raw)
In-Reply-To: <20200625163127.4000462-1-lee.jones@linaro.org>

si476x_core_send_command()'s 5th argument has never been called response.

This change must have occurred prior to the driver being Mainlined.

We're also taking the opportunity to bring the first description back
into line, making my OCD happy!

This fixes the following W=1 warning(s):

 drivers/mfd/si476x-cmd.c:264: warning: Function parameter or member 'resp' not described in 'si476x_core_send_command
 drivers/mfd/si476x-cmd.c:264: warning: Excess function parameter 'response' description in 'si476x_core_send_command'

Cc: Andrey Smirnov <andrew.smirnov@gmail.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mfd/si476x-cmd.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/mfd/si476x-cmd.c b/drivers/mfd/si476x-cmd.c
index 4a09ce9609c90..316d44c2edcd4 100644
--- a/drivers/mfd/si476x-cmd.c
+++ b/drivers/mfd/si476x-cmd.c
@@ -241,13 +241,13 @@ static int si476x_core_parse_and_nag_about_error(struct si476x_core *core)
 /**
  * si476x_core_send_command() - sends a command to si476x and waits its
  * response
- * @core:    si476x_device structure for the device we are
+ * @core:     si476x_device structure for the device we are
  *            communicating with
  * @command:  command id
  * @args:     command arguments we are sending
  * @argn:     actual size of @args
- * @response: buffer to place the expected response from the device
- * @respn:    actual size of @response
+ * @resp:     buffer to place the expected response from the device
+ * @respn:    actual size of @resp
  * @usecs:    amount of time to wait before reading the response (in
  *            usecs)
  *
-- 
2.25.1


  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 ` Lee Jones [this message]
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 ` [PATCH 10/10] mfd: si476x-cmd: Update si476x_cmd_am_rsq_status()'s kerneldoc Lee Jones

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-7-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).