[PATCH] drivers/ata: fix repeated words in comments

[PATCH] drivers/ata: fix repeated words in comments

[Jilin Yuan]

 Delete the redundant word 'in'.
 Delete the redundant word 'to'.

Signed-off-by: Jilin Yuan <yuanjilin@cdjrlc.com>
---
 drivers/ata/libata-eh.c        | 2 +-
 drivers/ata/libata-transport.c | 2 +-
 drivers/ata/pata_macio.c       | 2 +-
 drivers/ata/sata_dwc_460ex.c   | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
index 3307ed45fe4d..f2ac8340e769 100644
--- a/drivers/ata/libata-eh.c
+++ b/drivers/ata/libata-eh.c
@@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list *t)
  *
  *	Set ATA_PFLAG_EH_PENDING and activate fast drain if @fastdrain
  *	is non-zero and EH wasn't pending before.  Fast drain ensures
- *	that EH kicks in in timely manner.
+ *	that EH kicks in timely manner.
  *
  *	LOCKING:
  *	spin_lock_irqsave(host lock)
diff --git a/drivers/ata/libata-transport.c b/drivers/ata/libata-transport.c
index ca129854a88c..3a71107169ae 100644
--- a/drivers/ata/libata-transport.c
+++ b/drivers/ata/libata-transport.c
@@ -9,7 +9,7 @@
  * and various sysfs attributes to expose these topologies and management
  * interfaces to user-space.
  *
- * There are 3 objects defined in in this class:
+ * There are 3 objects defined in this class:
  * - ata_port
  * - ata_link
  * - ata_device
diff --git a/drivers/ata/pata_macio.c b/drivers/ata/pata_macio.c
index 42798402cf63..e7b03e8a9357 100644
--- a/drivers/ata/pata_macio.c
+++ b/drivers/ata/pata_macio.c
@@ -666,7 +666,7 @@ static u8 pata_macio_bmdma_status(struct ata_port *ap)
 	 * a multi-block transfer.
 	 *
 	 * - The dbdma fifo hasn't yet finished flushing to
-	 * to system memory when the disk interrupt occurs.
+	 * system memory when the disk interrupt occurs.
 	 *
 	 */
 
diff --git a/drivers/ata/sata_dwc_460ex.c b/drivers/ata/sata_dwc_460ex.c
index e3263e961045..a4c83a6e5631 100644
--- a/drivers/ata/sata_dwc_460ex.c
+++ b/drivers/ata/sata_dwc_460ex.c
@@ -1087,7 +1087,7 @@ static struct scsi_host_template sata_dwc_sht = {
 	/*
 	 * test-only: Currently this driver doesn't handle NCQ
 	 * correctly. We enable NCQ but set the queue depth to a
-	 * max of 1. This will get fixed in in a future release.
+	 * max of 1. This will get fixed in a future release.
 	 */
 	.sg_tablesize		= LIBATA_MAX_PRD,
 	/* .can_queue		= ATA_MAX_QUEUE, */
-- 
2.36.1

Re: [PATCH] drivers/ata: fix repeated words in comments

[James Bottomley]

On Sun, 2022-07-10 at 13:22 +0800, Jilin Yuan wrote:
> diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
> index 3307ed45fe4d..f2ac8340e769 100644
> --- a/drivers/ata/libata-eh.c
> +++ b/drivers/ata/libata-eh.c
> @@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list
> *t)
>   *
>   *	Set ATA_PFLAG_EH_PENDING and activate fast drain if @fastdrain
>   *	is non-zero and EH wasn't pending before.  Fast drain ensures
> - *	that EH kicks in in timely manner.
> + *	that EH kicks in timely manner.

The original is correct and the update doesn't make sense.  Of course
adding an article would make the original read better ...

James

Re: [PATCH] drivers/ata: fix repeated words in comments

[Damien Le Moal]

On 7/10/22 23:21, James Bottomley wrote:
> On Sun, 2022-07-10 at 13:22 +0800, Jilin Yuan wrote:
>> diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
>> index 3307ed45fe4d..f2ac8340e769 100644
>> --- a/drivers/ata/libata-eh.c
>> +++ b/drivers/ata/libata-eh.c
>> @@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list
>> *t)
>>   *
>>   *	Set ATA_PFLAG_EH_PENDING and activate fast drain if @fastdrain
>>   *	is non-zero and EH wasn't pending before.  Fast drain ensures
>> - *	that EH kicks in in timely manner.
>> + *	that EH kicks in timely manner.
> 
> The original is correct and the update doesn't make sense.  Of course
> adding an article would make the original read better ...

yep: ...that EH kicks in in a timely manner.

> 
> James
> 
> 


-- 
Damien Le Moal
Western Digital Research

[PATCH] drivers/ata: fix repeated words in comments

[Jilin Yuan]

 Delete the redundant word 'in'.
 Delete the redundant word 'to'.

Signed-off-by: Jilin Yuan <yuanjilin@cdjrlc.com>
---
 drivers/ata/libata-eh.c      | 2 +-
 drivers/ata/pata_macio.c     | 2 +-
 drivers/ata/sata_dwc_460ex.c | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
index 7c128c89b454..ca865a95cf24 100644
--- a/drivers/ata/libata-eh.c
+++ b/drivers/ata/libata-eh.c
@@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list *t)
  *
  *	Set ATA_PFLAG_EH_PENDING and activate fast drain if @fastdrain
  *	is non-zero and EH wasn't pending before.  Fast drain ensures
- *	that EH kicks in in timely manner.
+ *	that EH kicks in timely manner.
  *
  *	LOCKING:
  *	spin_lock_irqsave(host lock)
diff --git a/drivers/ata/pata_macio.c b/drivers/ata/pata_macio.c
index bfea2be2959a..076212fdb9d9 100644
--- a/drivers/ata/pata_macio.c
+++ b/drivers/ata/pata_macio.c
@@ -666,7 +666,7 @@ static u8 pata_macio_bmdma_status(struct ata_port *ap)
 	 * a multi-block transfer.
 	 *
 	 * - The dbdma fifo hasn't yet finished flushing to
-	 * to system memory when the disk interrupt occurs.
+	 * system memory when the disk interrupt occurs.
 	 *
 	 */
 
diff --git a/drivers/ata/sata_dwc_460ex.c b/drivers/ata/sata_dwc_460ex.c
index e3263e961045..a4c83a6e5631 100644
--- a/drivers/ata/sata_dwc_460ex.c
+++ b/drivers/ata/sata_dwc_460ex.c
@@ -1087,7 +1087,7 @@ static struct scsi_host_template sata_dwc_sht = {
 	/*
 	 * test-only: Currently this driver doesn't handle NCQ
 	 * correctly. We enable NCQ but set the queue depth to a
-	 * max of 1. This will get fixed in in a future release.
+	 * max of 1. This will get fixed in a future release.
 	 */
 	.sg_tablesize		= LIBATA_MAX_PRD,
 	/* .can_queue		= ATA_MAX_QUEUE, */
-- 
2.36.1

Re: [PATCH] drivers/ata: fix repeated words in comments

[Damien Le Moal]

On 8/25/22 21:36, Jilin Yuan wrote:
>  Delete the redundant word 'in'.
>  Delete the redundant word 'to'.


> Signed-off-by: Jilin Yuan <yuanjilin@cdjrlc.com>
> ---
>  drivers/ata/libata-eh.c      | 2 +-
>  drivers/ata/pata_macio.c     | 2 +-
>  drivers/ata/sata_dwc_460ex.c | 2 +-
>  3 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
> index 7c128c89b454..ca865a95cf24 100644
> --- a/drivers/ata/libata-eh.c
> +++ b/drivers/ata/libata-eh.c
> @@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list *t)
>   *
>   *	Set ATA_PFLAG_EH_PENDING and activate fast drain if @fastdrain
>   *	is non-zero and EH wasn't pending before.  Fast drain ensures
> - *	that EH kicks in in timely manner.
> + *	that EH kicks in timely manner.

As already commented, this fix is not correct. The sentence should read:

	that EH kicks-in in a timely manner.

The patch title for this fix should be:

ata: libata-eh: fix repeated words in comment

>   *
>   *	LOCKING:
>   *	spin_lock_irqsave(host lock)
> diff --git a/drivers/ata/pata_macio.c b/drivers/ata/pata_macio.c
> index bfea2be2959a..076212fdb9d9 100644
> --- a/drivers/ata/pata_macio.c
> +++ b/drivers/ata/pata_macio.c
> @@ -666,7 +666,7 @@ static u8 pata_macio_bmdma_status(struct ata_port *ap)
>  	 * a multi-block transfer.
>  	 *
>  	 * - The dbdma fifo hasn't yet finished flushing to
> -	 * to system memory when the disk interrupt occurs.
> +	 * system memory when the disk interrupt occurs.
>  	 *

While at it, please remove the above useless extra "*" line.

>  	 */
>  
> diff --git a/drivers/ata/sata_dwc_460ex.c b/drivers/ata/sata_dwc_460ex.c
> index e3263e961045..a4c83a6e5631 100644
> --- a/drivers/ata/sata_dwc_460ex.c
> +++ b/drivers/ata/sata_dwc_460ex.c
> @@ -1087,7 +1087,7 @@ static struct scsi_host_template sata_dwc_sht = {
>  	/*
>  	 * test-only: Currently this driver doesn't handle NCQ
>  	 * correctly. We enable NCQ but set the queue depth to a
> -	 * max of 1. This will get fixed in in a future release.
> +	 * max of 1. This will get fixed in a future release.
>  	 */
>  	.sg_tablesize		= LIBATA_MAX_PRD,
>  	/* .can_queue		= ATA_MAX_QUEUE, */

Please move this second hunk to a different patch with the title:

ata: sata_dwc_460ex: fix repeated words in comment

-- 
Damien Le Moal
Western Digital Research

[PATCH] drivers/ata: fix repeated words in comments

[wangjianli]

Delete the redundant word 'in'.

Signed-off-by: wangjianli <wangjianli@cdjrlc.com>
---
 drivers/ata/sata_dwc_460ex.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/sata_dwc_460ex.c b/drivers/ata/sata_dwc_460ex.c
index e3263e961045..a4c83a6e5631 100644
--- a/drivers/ata/sata_dwc_460ex.c
+++ b/drivers/ata/sata_dwc_460ex.c
@@ -1087,7 +1087,7 @@ static struct scsi_host_template sata_dwc_sht = {
 	/*
 	 * test-only: Currently this driver doesn't handle NCQ
 	 * correctly. We enable NCQ but set the queue depth to a
-	 * max of 1. This will get fixed in in a future release.
+	 * max of 1. This will get fixed in a future release.
 	 */
 	.sg_tablesize		= LIBATA_MAX_PRD,
 	/* .can_queue		= ATA_MAX_QUEUE, */
-- 
2.36.1

[PATCH] drivers/ata: fix repeated words in comments

[wangjianli]

Delete the redundant word 'in'.

Signed-off-by: wangjianli <wangjianli@cdjrlc.com>
---
 drivers/ata/libata-eh.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
index 7c128c89b454..ca865a95cf24 100644
--- a/drivers/ata/libata-eh.c
+++ b/drivers/ata/libata-eh.c
@@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list *t)
  *
  *	Set ATA_PFLAG_EH_PENDING and activate fast drain if @fastdrain
  *	is non-zero and EH wasn't pending before.  Fast drain ensures
- *	that EH kicks in in timely manner.
+ *	that EH kicks in timely manner.
  *
  *	LOCKING:
  *	spin_lock_irqsave(host lock)
-- 
2.36.1

Re: [PATCH] drivers/ata: fix repeated words in comments

[Conor.Dooley]

On 08/09/2022 13:49, wangjianli wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> Delete the redundant word 'in'.
> 
> Signed-off-by: wangjianli <wangjianli@cdjrlc.com>
> ---
>   drivers/ata/libata-eh.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
> index 7c128c89b454..ca865a95cf24 100644
> --- a/drivers/ata/libata-eh.c
> +++ b/drivers/ata/libata-eh.c
> @@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list *t)
>    *
>    *     Set ATA_PFLAG_EH_PENDING and activate fast drain if @fastdrain
>    *     is non-zero and EH wasn't pending before.  Fast drain ensures
> - *     that EH kicks in in timely manner.
> + *     that EH kicks in timely manner.

Hey wangjianli,
This does not look like the right fix to me.. To me, it looks like it
should be s/in in/in in a/.

If you're using an automated tool, which I can only assume you are,
to find these typos it'd be a good idea to check the output for
correctness prior to sending patches.

Thanks,
Conor.

>    *
>    *     LOCKING:
>    *     spin_lock_irqsave(host lock)
> --
> 2.36.1
> 

Re: [PATCH] drivers/ata: fix repeated words in comments

[James Bottomley]

On Thu, 2022-09-08 at 12:56 +0000, Conor.Dooley@microchip.com wrote:
> On 08/09/2022 13:49, wangjianli wrote:
> > EXTERNAL EMAIL: Do not click links or open attachments unless you
> > know the content is safe
> > 
> > Delete the redundant word 'in'.
> > 
> > Signed-off-by: wangjianli <wangjianli@cdjrlc.com>
> > ---
> >   drivers/ata/libata-eh.c | 2 +-
> >   1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
> > index 7c128c89b454..ca865a95cf24 100644
> > --- a/drivers/ata/libata-eh.c
> > +++ b/drivers/ata/libata-eh.c
> > @@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list
> > *t)
> >    *
> >    *     Set ATA_PFLAG_EH_PENDING and activate fast drain if
> > @fastdrain
> >    *     is non-zero and EH wasn't pending before.  Fast drain
> > ensures
> > - *     that EH kicks in in timely manner.
> > + *     that EH kicks in timely manner.
> 
> Hey wangjianli,
> This does not look like the right fix to me.. To me, it looks like it
> should be s/in in/in in a/.
> 
> If you're using an automated tool, which I can only assume you are,
> to find these typos it'd be a good idea to check the output for
> correctness prior to sending patches.

And it would also have been nice to accommodate the exact same feedback
last time these patches were posted:

https://lore.kernel.org/all/cec12e246d7151f6041bf553629a3047e81d4afe.camel@HansenPartnership.com/

It's really disappointing you haven't accommodated any feedback either
into your bot or the patches it sends.  Not doing so really does render
this work largely useless.

James

Re: [PATCH] drivers/ata: fix repeated words in comments

[Conor.Dooley]

On 08/09/2022 14:02, James Bottomley wrote:
> [You don't often get email from james.bottomley@hansenpartnership.com. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> On Thu, 2022-09-08 at 12:56 +0000, Conor.Dooley@microchip.com wrote:
>> On 08/09/2022 13:49, wangjianli wrote:
>>> EXTERNAL EMAIL: Do not click links or open attachments unless you
>>> know the content is safe
>>>
>>> Delete the redundant word 'in'.
>>>
>>> Signed-off-by: wangjianli <wangjianli@cdjrlc.com>
>>> ---
>>>    drivers/ata/libata-eh.c | 2 +-
>>>    1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
>>> index 7c128c89b454..ca865a95cf24 100644
>>> --- a/drivers/ata/libata-eh.c
>>> +++ b/drivers/ata/libata-eh.c
>>> @@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list
>>> *t)
>>>     *
>>>     *     Set ATA_PFLAG_EH_PENDING and activate fast drain if
>>> @fastdrain
>>>     *     is non-zero and EH wasn't pending before.  Fast drain
>>> ensures
>>> - *     that EH kicks in in timely manner.
>>> + *     that EH kicks in timely manner.
>>
>> Hey wangjianli,
>> This does not look like the right fix to me.. To me, it looks like it
>> should be s/in in/in in a/.
>>
>> If you're using an automated tool, which I can only assume you are,
>> to find these typos it'd be a good idea to check the output for
>> correctness prior to sending patches.
> 
> And it would also have been nice to accommodate the exact same feedback
> last time these patches were posted:
> 
> https://lore.kernel.org/all/cec12e246d7151f6041bf553629a3047e81d4afe.camel@HansenPartnership.com/
> 
> It's really disappointing you haven't accommodated any feedback either
> into your bot or the patches it sends.  Not doing so really does render
> this work largely useless.

I've been replying a bit to these typo "fixes" that are not fixes since
I am a native speaker and maybe some things get lost in translation but
I have pretty much never got responses from the patch submitters.

It's a little bit frustrating since fairly often, the fix is not to
remove the dupe, but instead s/in in/is in/ etc.

If there's a tool running against this stuff but maintainers are not
applying the patches as the "fixes" are not fixes it's only going to
keep generating the same patches over and over is it not?

Re: [PATCH] drivers/ata: fix repeated words in comments

[James Bottomley]

On Thu, 2022-09-08 at 13:09 +0000, Conor.Dooley@microchip.com wrote:
[...]
> If there's a tool running against this stuff but maintainers are not
> applying the patches as the "fixes" are not fixes it's only going to
> keep generating the same patches over and over is it not?

That's up to the maintainers, but it's fairly easy to ignore patches
from given sources however often they are repeated.  There's a lot of
wrong patches that keep getting repeated ...

My own take is that the value would be marginal if all the patches were
correct, but they could be applied with minimal effort using patch
automation.  Once you have to verify correctness of each patch, I don't
think the tracking and verification effort is worth the marginal
improvement, but that's a maintainer call.

Regards,

James

Re: [PATCH] drivers/ata: fix repeated words in comments

[Damien Le Moal]

On 2022/09/08 22:02, James Bottomley wrote:
> On Thu, 2022-09-08 at 12:56 +0000, Conor.Dooley@microchip.com wrote:
>> On 08/09/2022 13:49, wangjianli wrote:
>>> EXTERNAL EMAIL: Do not click links or open attachments unless you
>>> know the content is safe
>>>
>>> Delete the redundant word 'in'.
>>>
>>> Signed-off-by: wangjianli <wangjianli@cdjrlc.com>
>>> ---
>>>   drivers/ata/libata-eh.c | 2 +-
>>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c
>>> index 7c128c89b454..ca865a95cf24 100644
>>> --- a/drivers/ata/libata-eh.c
>>> +++ b/drivers/ata/libata-eh.c
>>> @@ -863,7 +863,7 @@ void ata_eh_fastdrain_timerfn(struct timer_list
>>> *t)
>>>    *
>>>    *     Set ATA_PFLAG_EH_PENDING and activate fast drain if
>>> @fastdrain
>>>    *     is non-zero and EH wasn't pending before.  Fast drain
>>> ensures
>>> - *     that EH kicks in in timely manner.
>>> + *     that EH kicks in timely manner.
>>
>> Hey wangjianli,
>> This does not look like the right fix to me.. To me, it looks like it
>> should be s/in in/in in a/.
>>
>> If you're using an automated tool, which I can only assume you are,
>> to find these typos it'd be a good idea to check the output for
>> correctness prior to sending patches.
> 
> And it would also have been nice to accommodate the exact same feedback
> last time these patches were posted:
> 
> https://lore.kernel.org/all/cec12e246d7151f6041bf553629a3047e81d4afe.camel@HansenPartnership.com/
> 
> It's really disappointing you haven't accommodated any feedback either
> into your bot or the patches it sends.  Not doing so really does render
> this work largely useless.

And another submitter sent a similar incorrect "fix", twice, ignoring my
comments. I am OK with applying such fixes, even though they have little value.
But the submitter has to be willing to listen and fix their patches. I will not
do that for them :)


-- 
Damien Le Moal
Western Digital Research