2022-01-21 19:00:18

by Ajith P V

[permalink] [raw]
Subject: [PATCH] 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(-)

diff --git a/drivers/staging/fwserial/fwserial.h b/drivers/staging/fwserial/fwserial.h
index 1d15f183e0fa..ae7cf84ceafc 100644
--- a/drivers/staging/fwserial/fwserial.h
+++ b/drivers/staging/fwserial/fwserial.h
@@ -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
--
2.17.1


2022-01-21 19:25:19

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] staging: fwserial: rearrange comment to avoid warning

Hi--

On 1/19/22 00:41, Ajith P V wrote:
> 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.

> Signed-off-by: Ajith P V <[email protected]>
> ---
> drivers/staging/fwserial/fwserial.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/staging/fwserial/fwserial.h b/drivers/staging/fwserial/fwserial.h
> index 1d15f183e0fa..ae7cf84ceafc 100644
> --- a/drivers/staging/fwserial/fwserial.h
> +++ b/drivers/staging/fwserial/fwserial.h
> @@ -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.
--
~Randy

2022-01-21 19:54:02

by Dan Carpenter

[permalink] [raw]
Subject: Re: [PATCH] staging: fwserial: rearrange comment to avoid warning

On Wed, Jan 19, 2022 at 07:19:24AM -0800, Randy Dunlap wrote:
> Hi--
>
> On 1/19/22 00:41, Ajith P V wrote:
> > 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
^^^^
> 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