linux-kernel - Re: [PATCH v3] checkpatch: add dedicated checker for 'Fixes:' tag

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200428140649.GA30042@udknight>
Date:   Tue, 28 Apr 2020 22:06:49 +0800
From:   Wang YanQing <udknight@...il.com>
To:     Markus Elfring <Markus.Elfring@....de>
Cc:     Joe Perches <joe@...ches.com>, Andy Whitcroft <apw@...onical.com>,
        kernel-janitors@...r.kernel.org, linux-kernel@...r.kernel.org,
        Alexei Starovoitov <alexei.starovoitov@...il.com>,
        Matteo Croce <mcroce@...hat.com>
Subject: Re: [PATCH v3] checkpatch: add dedicated checker for 'Fixes:' tag

On Tue, Apr 28, 2020 at 08:21:37AM +0200, Markus Elfring wrote:
> > ...
> > Do not split the tag across multiple
> > lines, tags are exempt from the "wrap at 75 columns" rule in order to simplify
> > parsing scripts
> > ...
> 
> I suggest to reformat the quotation.
> 
> “…
> Do not split the tag across multiple lines, tags are exempt from
> the "wrap at 75 columns" rule in order to simplify parsing scripts.
> …”
> 
> 
> > And there is no 'Fixes:' tag format checker in checkpatch to check
> > the commit id length too, so let's add dedicated checker to check
> > these conditions for 'Fixes:' tag.
> 
> It seems that there are further challenges to consider for an imperative wording
> in such a change description.
> 
> How do you think about the following wording variant?
> 
>    The script “checkpatch.pl” did not provide a check for the commit
>    identification length. Thus add a dedicated check.
> 
> 
> >  v2-v3
> 
> I would find a shorter version identification (without the arrow)
> also sufficient.
> 
> 
> >  1:No modification to GIT_COMMIT_ID checker.
> 
> Would you like to add a space character for the item enumeration?
> 
> 
> >    I make a mistake previously, …
> 
> Would you like to use the word “made” here?
> 
> 
> > +		    my $id = '0123456789ab';
> > +		    my $orig_desc = "commit description";
> 
> How much do these variable initialisations matter?
>

Well! Thanks and you are right,  I will fix them in next version.

> 
> > +			$lines = 0 if ($1 =~ /^\(\"(?:.*)\"\)$/i);
> 
> I wonder why you see a need to use a non-capturing group in such
> a regular expression (when no alternatives were specified there).

I guess it is a better perl programming practice that use non-capturing group always when
you don't need to use the '$' to access it, it will make code a little faster I guess.

> 
> 
> > +				ERROR("FIXES_TAG",
> > +					"Please use 'Fixes:' tag with commit description style '<12+ chars of sha1> (\"<title line>\")', and the title line doesn't across multiple lines - ie: '$fixes_tag_fmt'\n" . $herecurr);
> 
> * Would we like to support any other quotation characters around
>   the commit summary?
>

I think we don't need now and people could patch it easily when
we need others in future:)

> * I propose to split the error message.
>   May it become multi-line?

Yes

> 
> * How do you think about another wording variant?
> 
>   The title must be specified as a single line (without line breaks).
>

Ok

> * Would you like to point questionable commit titles out?
> 
> Regards,
> Markus

No, I think your previous wording variant is clear enough.

Thanks again!