Skip to contentSkip to conversation

staging: fwserial: rearrange comment to avoid warning

PATCH In review Ajith P V 3 participants 3 messages Jan 19, 2022 Staging

lore
Share & tools
lore

Ajith P V

author
#0 lore raw

PATCH 1/1 staging: fwserial: rearrange comment to avoid warning

fwserial.h comment contains word "bits" 2 times together. The sentence required this however it produce warning. Change the comment to make it proper.

Signed-off-by Ajith P V <[email protected]>
---
 drivers/staging/fwserial/fwserial.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/fwserial/fwserial.h +1 -1
index 1d15f183e0fa..ae7cf84ceafc 100644
@@ -203,7 +203,7 @@ struct fwconsole_ops {
  * @break_last: timestamp in jiffies from last emit_breaks
  * @hangup: work responsible for HUPing when carrier is dropped/lost
  * @mstatus: loose virtualization of LSR/MSR
- *         bits 15..0  correspond to TIOCM_* bits
+ *         bits 15..0  correspond to bits TIOCM_*
  *         bits 19..16 reserved for mctrl
  *         bit 20      OOB_TX_THROTTLE
  *	   bits 23..21 reserved
Signature · 1 line
2.17.1
#1 lore raw

Hi--

Quoted 3 lines · Ajith P V

fwserial.h comment contains word "bits" 2 times together. The sentence required this however it produce warning. Change the comment to make it proper.

Is that a warning from checkpatch?
If so, it's OK to ignore something like that.
checkpatch isn't perfect and we know that.

or if someone wants to apply the patch, ok.

Quoted 10 lines
Signed-off-by Ajith P V <[email protected]>
---
 drivers/staging/fwserial/fwserial.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/fwserial/fwserial.h +0 -0
index 1d15f183e0fa..ae7cf84ceafc 100644

drivers/staging/fwserial/fwserial.h struct fwconsole_ops { · line 209

Quoted 8 lines
drivers/staging/fwserial/fwserial.h +1 -1
@@ -203,7 +203,7 @@ struct fwconsole_ops {
  * @break_last: timestamp in jiffies from last emit_breaks
  * @hangup: work responsible for HUPing when carrier is dropped/lost
  * @mstatus: loose virtualization of LSR/MSR
- *         bits 15..0  correspond to TIOCM_* bits
+ *         bits 15..0  correspond to bits TIOCM_*
  *         bits 19..16 reserved for mctrl
  *         bit 20      OOB_TX_THROTTLE
  *	   bits 23..21 reserved

thanks.

Signature · 1 line
~Randy
#2 lore raw
Quoted 8 lines · Randy Dunlap

Hi--

Quoted 3 lines · Ajith P V

fwserial.h comment contains word "bits" 2 times together. The sentence required this however it produce warning. Change the comment to make it proper.

Is that a warning from checkpatch?

Yeah. You're right.

WARNING: Possible repeated word: 'bits' #207: FILE: drivers/staging/fwserial/fwserial.h:207:
+ * bits 15..0 correspond to TIOCM_* bits

                                              ^^^^
+ *         bits 19..16 reserved for mctrl
            ^^^^
Quoted 2 lines

If so, it's OK to ignore something like that.
checkpatch isn't perfect and we know that.

Yep. Checkpatch is not the boss of us.

regards,
dan carpenter