public inbox for linux-snps-arc@lists.infradead.org
 help / color / mirror / Atom feed
From: <Conor.Dooley@microchip.com>
To: <julia.lawall@inria.fr>, <bagasdotme@gmail.com>
Cc: <Shahab.Vahedi@synopsys.com>, <yuanjilin@cdjrlc.com>,
	<vgupta@kernel.org>, <rdunlap@infradead.org>,
	<linux-snps-arc@lists.infradead.org>,
	<linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] ARC:mm:Fix syntax errors in comments
Date: Wed, 22 Jun 2022 14:10:59 +0000	[thread overview]
Message-ID: <b92dad21-537c-c2c6-2f03-88b2ff6e268e@microchip.com> (raw)
In-Reply-To: <alpine.DEB.2.22.394.2206220943200.6198@hadrien>



On 22/06/2022 14:46, Julia Lawall wrote:
> 
> 
> On Wed, 22 Jun 2022, Bagas Sanjaya wrote:
> 
>> On 6/22/22 16:38, Julia Lawall wrote:
>>>>> So code that is fine will have typos forever?  Fixing typos in comments
>>>>> doesn't break git blame for the following code.  And typos in comments
>>>>> give a bad impression about the state of the code in general.
>>>>
>>>> Of course not! Documentation is as important as the code, if not even more.
>>>> However, fixing typos to increase your commit counts to a reputable project
>>>> is not fine either. For instance, many of these proposed fixes are targeting
>>>> one single typo at a time. Couldn't they just be sent altogether!?!
>>>
>>> I have the impression that the person is just trying to figure out the
>>> patch submission process.  For example, the subject lines are not
>>> formatter in the standard way (I sent the person a private email about
>>> that).  Perhaps just let him know about how you would rather have received
>>> the patches.
>>
>> In recent times I had seen many typofix patches sent to LKML. You can see most
>> of them by querying `s:"fix typo"` on lore.kernel.org. Some of these patches
>> have been merged, though.
>>
>> What I say as starter thread is "ideal" scenario as described in
>> Documentation/process/2.Process.rst; that is we prefer to see these minor
>> fixes as part of real patches work (say refactoring), rather than just being
>> trivial patches.
>>
>> But what most reviewers here missed is how these typos are found? I guess
>> these can be from codespell or some other tools, or even manual review,
>> then send the fixes en mass.
>>
>> Take a look at "fix typo in a comment" aka "delete redundant word" patches
>> at [1], [2], [3]. and [4].
>>
>> [1]: https://lore.kernel.org/lkml/20220618132659.17100-1-wangxiang@cdjrlc.com/
>> [2]: https://lore.kernel.org/lkml/20220618130349.11507-1-wangxiang@cdjrlc.com/
>> [3]: https://lore.kernel.org/lkml/20220616163830.11366-1-wangxiang@cdjrlc.com/
>> [4]: https://lore.kernel.org/lkml/20220606123419.29109-1-wangxiang@cdjrlc.com/
>>
>> IMHO, these patches should have been in a single, consolidated patch, since
>> these strip duplicate (hence redundant) word (single logical change).
> 
> They go to different maintainers, so perhaps each one would prefer to get
> their own patches?  There was a trivial tree, but it is apparently not
> very active.
> 
> It would indeed be good to indicate how the problems were found.  That
> could suggest whether the problem has been addressed comprehensively, or
> whether just some random issues have been detected.

It would be interesting to see what tool it is, because there appear to be
a bunch of false positives (although maybe that is on the user to read and
understand the tool's output)

Thanks,
Conor.
_______________________________________________
linux-snps-arc mailing list
linux-snps-arc@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-snps-arc

  reply	other threads:[~2022-06-22 14:11 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-22  8:04 [PATCH] ARC:mm:Fix syntax errors in comments Jilin Yuan
2022-06-22  8:30 ` Bagas Sanjaya
2022-06-22  8:42   ` Shahab Vahedi
2022-06-22  9:16     ` Julia Lawall
2022-06-22  9:25       ` Shahab Vahedi
2022-06-22  9:38         ` Julia Lawall
2022-06-22 13:20           ` Bagas Sanjaya
2022-06-22 13:46             ` Julia Lawall
2022-06-22 14:10               ` Conor.Dooley [this message]
2022-06-23  2:50   ` Vineet Gupta
2022-06-23  7:56     ` Bagas Sanjaya
2022-06-24  1:57       ` Vineet Gupta
2022-06-24  3:16         ` Bagas Sanjaya

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=b92dad21-537c-c2c6-2f03-88b2ff6e268e@microchip.com \
    --to=conor.dooley@microchip.com \
    --cc=Shahab.Vahedi@synopsys.com \
    --cc=bagasdotme@gmail.com \
    --cc=julia.lawall@inria.fr \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-snps-arc@lists.infradead.org \
    --cc=rdunlap@infradead.org \
    --cc=vgupta@kernel.org \
    --cc=yuanjilin@cdjrlc.com \
    /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