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: <35069ae9-cdb4-4728-5e94-6d863dd2721c@web.de>
Date:   Tue, 28 Apr 2020 08:21:37 +0200
From:   Markus Elfring <Markus.Elfring@....de>
To:     Wang YanQing <udknight@...il.com>, Joe Perches <joe@...ches.com>,
        Andy Whitcroft <apw@...onical.com>,
        kernel-janitors@...r.kernel.org
Cc:     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

> ...
> 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?

> +			$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).

> +				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 propose to split the error message.
  May it become multi-line?

* How do you think about another wording variant?

  The title must be specified as a single line (without line breaks).

* Would you like to point questionable commit titles out?

Regards,
Markus