From: Alison Schofield <alison.schofield@intel.com>
To: "Felix N. Kimbu" <felixkimbu1@gmail.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org,
outreachy@lists.linux.dev
Subject: Re: [PATCH] staging: pi433: Correct comment typos in pi433_if.c
Date: Wed, 20 Mar 2024 12:11:55 -0700 [thread overview]
Message-ID: <Zfs0+0C7nzKiBjGy@aschofie-mobl2> (raw)
In-Reply-To: <Zfk0UfLh3rRf6qDv@MOLeToid>
On Tue, Mar 19, 2024 at 07:44:33AM +0100, Felix N. Kimbu wrote:
> Correct typos in pi433_if.c comments to address the following checkpatch checks;
>
> CHECK: 'interace' may be misspelled - perhaps 'interface'?
> #13: FILE: drivers/staging/pi433/pi433_if.c:13:
> + * HopeRf with a similar interace - e. g. RFM69HCW, RFM12, RFM95, ...
> ^^^^^^^^
>
> CHECK: 'ebedded' may be misspelled - perhaps 'embedded'?
> #71: FILE: drivers/staging/pi433/pi433_if.c:71:
> + * so we have just one rx config, ebedded in device struct
> ^^^^^^^
>
> CHECK: 'reenabled' may be misspelled - perhaps 're-enabled'?
> #650: FILE: drivers/staging/pi433/pi433_if.c:650:
> + * irq will be reenabled after tx config is set
> ^^^^^^^^^
>
> CHECK: 'pendig' may be misspelled - perhaps 'pending'?
> #926: FILE: drivers/staging/pi433/pi433_if.c:926:
> + /* during pendig read request, change of config not allowed */
> ^^^^^^
>
> Signed-off-by: Felix N. Kimbu <felixkimbu1@gmail.com>
Hi Felix,
This commit msg and log can be trimmed. Please take a look at samples in
staging or here on the Outreachy list like this:
https://lore.kernel.org/outreachy/00be5f2a97b0c899279bd8f9cd27634186b77b9d.1666299151.git.drv@mailo.com/
Checkpatch complained:
WARNING: Prefer a maximum 75 chars per line (possible unwrapped commit description?)
#311:
Correct typos in pi433_if.c comments to address the following checkpatch checks;
WARNING: Commit log lines starting with '#' are dropped by git as comments
#314:
#13: FILE: drivers/staging/pi433/pi433_if.c:13:
WARNING: 'interace' may be misspelled - perhaps 'interface'?
#315:
+ * HopeRf with a similar interace - e. g. RFM69HCW, RFM12, RFM95, ...
^^^^^^^^
WARNING: Commit log lines starting with '#' are dropped by git as comments
#319:
#71: FILE: drivers/staging/pi433/pi433_if.c:71:
WARNING: 'ebedded' may be misspelled - perhaps 'embedded'?
#320:
+ * so we have just one rx config, ebedded in device struct
^^^^^^^
WARNING: Commit log lines starting with '#' are dropped by git as comments
#324:
#650: FILE: drivers/staging/pi433/pi433_if.c:650:
WARNING: 'reenabled' may be misspelled - perhaps 're-enabled'?
#325:
+ * irq will be reenabled after tx config is set
^^^^^^^^^
WARNING: Commit log lines starting with '#' are dropped by git as comments
#329:
#926: FILE: drivers/staging/pi433/pi433_if.c:926:
WARNING: 'pendig' may be misspelled - perhaps 'pending'?
#330:
+ /* during pendig read request, change of config not allowed */
^^^^^^
total: 0 errors, 9 warnings, 0 checks, 32 lines checked
NOTE: For some of the reported defects, checkpatch may be able to
mechanically convert to the typical style using --fix or --fix-inplace.
/home/cxluser/patches/outreachy/felix-spell.patch has style problems, please review.
NOTE: If any of the errors are false positives, please report
them to the maintainer, see CHECKPATCH in MAINTAINERS.
> ---
> drivers/staging/pi433/pi433_if.c | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/staging/pi433/pi433_if.c b/drivers/staging/pi433/pi433_if.c
> index b6c4917d515e..81de98c0245a 100644
> --- a/drivers/staging/pi433/pi433_if.c
> +++ b/drivers/staging/pi433/pi433_if.c
> @@ -10,7 +10,7 @@
> * devices, basing on HopeRfs rf69.
> *
> * The driver can also be extended, to support other modules of
> - * HopeRf with a similar interace - e. g. RFM69HCW, RFM12, RFM95, ...
> + * HopeRf with a similar interface - e. g. RFM69HCW, RFM12, RFM95, ...
> *
> * Copyright (C) 2016 Wolf-Entwicklungen
> * Marcus Wolf <linux@wolf-entwicklungen.de>
> @@ -68,7 +68,7 @@ static const struct class pi433_class = {
> */
> /*
> * rx config is device specific
> - * so we have just one rx config, ebedded in device struct
> + * so we have just one rx config, embedded in device struct
> */
> struct pi433_device {
> /* device handling related values */
> @@ -647,7 +647,7 @@ static int pi433_tx_thread(void *data)
>
> /*
> * prevent race conditions
> - * irq will be reenabled after tx config is set
> + * irq will be re-enabled after tx config is set
> */
> disable_irq(device->irq_num[DIO0]);
> device->tx_active = true;
> @@ -923,7 +923,7 @@ static long pi433_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
> case PI433_IOC_WR_RX_CFG:
> mutex_lock(&device->rx_lock);
>
> - /* during pendig read request, change of config not allowed */
> + /* during pending read request, change of config not allowed */
> if (device->rx_active) {
> mutex_unlock(&device->rx_lock);
> return -EAGAIN;
> --
> 2.34.1
>
>
next prev parent reply other threads:[~2024-03-20 19:11 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-19 6:44 [PATCH] staging: pi433: Correct comment typos in pi433_if.c Felix N. Kimbu
2024-03-20 19:11 ` Alison Schofield [this message]
2024-03-23 5:47 ` Felix Kimbu
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=Zfs0+0C7nzKiBjGy@aschofie-mobl2 \
--to=alison.schofield@intel.com \
--cc=felixkimbu1@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--cc=outreachy@lists.linux.dev \
/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 read-only IMAP folder(s) and NNTP newsgroup(s).