staging: pi433: Correct comment typos in pi433_if.c
PATCH 1/1 staging: pi433: Correct comment typos in pi433_if.c
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 */
^^^^^^
--- drivers/staging/pi433/pi433_if.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/staging/pi433/pi433_if.c +4 -4
@@ -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 <[email protected]>
@@ -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 ;
Signature · 1 line
2.34.1
Quoted 15 lines · Felix N. Kimbu
Correct typos in
pi433_if.ccomments 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
Quoted 8 lines
^^^^^^^^^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 <[email protected]>
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.
Quoted 48 lines
--- drivers/staging/pi433/pi433_if.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)drivers/staging/pi433/pi433_if.c +4
-4@@ -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 <[email protected]> @@ -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 ;Signature · 1 line
2.34.1
On Wed, Mar 20, 2024 at 8:11 PM Alison Schofield
<[email protected]> wrote
Quoted 8 lines
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/
Greetings Alison,
Thanks for the correction, let me fix that.
Regards,
Felix.