[Linux-kernel-mentees] [PATCH RFC] checkpatch: add warning for lines starting with a '#' in commit log

Lukas Bulwahn lukas.bulwahn at gmail.com
Tue Dec 1 18:08:18 UTC 2020


On Tue, Dec 1, 2020 at 7:06 PM Dwaipayan Ray <dwaipayanray1 at gmail.com> wrote:
>
> On Tue, Dec 1, 2020 at 11:19 PM Peilin Ye <yepeilin.cs at gmail.com> wrote:
> >
> > On Tue, Dec 01, 2020 at 09:22:12PM +0530, Dwaipayan Ray wrote:
> > > Commit log lines starting with a '#' can be ignored by git if the
> > > corresponding commit message is reworded by a maintainer using
> > > git commit --ammend. This minute error can be easily avoided if
> >
> > s/minute/minor/
> >
> > > checkpatch warns for the same.
> > >
> > > Add a new check which emits a warning on finding lines starting with
> > > a '#'. Also add a quick fix by adding a tab infront of such lines.
> >
> > s/infront/in front/
> >
> > > Suggested-by: Peilin Ye <yepeilin.cs at gmail.com>
> > > Signed-off-by: Dwaipayan Ray <dwaipayanray1 at gmail.com>
> > > ---
> > >  scripts/checkpatch.pl | 9 +++++++++
> > >  1 file changed, 9 insertions(+)
> > >
> > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > > index dabe39ca819e..10665b9a3d77 100755
> > > --- a/scripts/checkpatch.pl
> > > +++ b/scripts/checkpatch.pl
> > > @@ -2966,6 +2966,15 @@ sub process {
> > >                       $commit_log_possible_stack_dump = 0;
> > >               }
> > >
> > > +# Check for lines starting with an #
> > > +             if ($in_commit_log && $line =~ /^#/) {
> > > +                     if (WARN("POSSIBLE_IGNORED_LINE",
> > > +                              "Commit log lines starting with a '#' might be ignored if the commit message is reworded using git commit --ammend.\n" . $herecurr)
> >
> > Also a nitpick, `commit --amend` isn't the only way to reword it, I did
> > it using `rebase -i`.
> >
> > I think something like "Commit log lines starting with a '#' might be
> > dropped by git.\n" is sufficient, without being overspecific?
>
> I think that might be better. I would probably add `dropped by git when
> the commit message is reworded`. I totally forgot that rebase could also
> do it. Thanks.
>
> >
> > Otherwise,
> >
> > Tested-by: Peilin Ye <yepeilin.cs at gmail.com>
> >
>
> Thanks for the feedback and the tag Peilin.
> I will have these changes done.
>
> If Lukas doesn't have any problem with this, I can send it to Joe then.
>

Looks good to me.

Lukas

> Thanks & Regards,
> Dwaipayan.


More information about the Linux-kernel-mentees mailing list