From: Philippe Schenker <philippe.schenker@toradex.com>
To: "corbet@lwn.net" <corbet@lwn.net>,
"sfr@canb.auug.org.au" <sfr@canb.auug.org.au>,
"niklas.soderlund@corigine.com" <niklas.soderlund@corigine.com>,
"dwaipayanray1@gmail.com" <dwaipayanray1@gmail.com>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
"joe@perches.com" <joe@perches.com>,
"lukas.bulwahn@gmail.com" <lukas.bulwahn@gmail.com>,
"apw@canonical.com" <apw@canonical.com>
Cc: "louis.peens@corigine.com" <louis.peens@corigine.com>,
"simon.horman@corigine.com" <simon.horman@corigine.com>,
"oss-drivers@corigine.com" <oss-drivers@corigine.com>
Subject: Re: [PATCH v6] checkpatch: warn for non-standard fixes tag style
Date: Sun, 11 Sep 2022 15:38:30 +0000 [thread overview]
Message-ID: <7b2159922e989b1a5d5a3662fddb3c5ee2a97761.camel@toradex.com> (raw)
In-Reply-To: <20220910083835.2219239-1-niklas.soderlund@corigine.com>
On Sat, 2022-09-10 at 10:38 +0200, Niklas Söderlund wrote:
> Add a warning for fixes tags that does not fall in line with the
> standards specified by the community.
>
> Signed-off-by: Niklas Söderlund <niklas.soderlund@corigine.com>
> Reviewed-by: Simon Horman <simon.horman@corigine.com>
> Reviewed-by: Louis Peens <louis.peens@corigine.com>
Reviewed-by: Philippe Schenker <philippe.schenker@toradex.com>
> ---
> * Changes since v5
> - Add support for --fix option for checkpatch.pl.
>
> * Changes since v4
> - Extend test to cover lines with whitespace before the fixes: tag,
> e.g.
> match check on /^\s*fixes:?/i.
>
> * Changes since v3
> - Add test that title in tag match title of commit referenced by sha1.
>
> * Changes since v2
> - Change the pattern to match on 'fixes:?' to catch more malformed
> tags.
>
> * Changes since v1
> - Update the documentation wording and add mention one cause of the
> message can be that email program splits the tag over multiple
> lines.
> ---
> Documentation/dev-tools/checkpatch.rst | 8 +++++
> scripts/checkpatch.pl | 43
> ++++++++++++++++++++++++++
> 2 files changed, 51 insertions(+)
>
> diff --git a/Documentation/dev-tools/checkpatch.rst
> b/Documentation/dev-tools/checkpatch.rst
> index b52452bc2963..8c8456a3bd18 100644
> --- a/Documentation/dev-tools/checkpatch.rst
> +++ b/Documentation/dev-tools/checkpatch.rst
> @@ -612,6 +612,14 @@ Commit message
>
> See:
> https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
>
> + **BAD_FIXES_TAG**
> + The Fixes: tag is malformed or does not fall in line with the
> standards
> + specified by the community. This can occur if the tag have been
> split into
> + multiple lines (e.g., when pasted in email program with word
> wrapping
> + enabled).
> +
> + See:
> https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
> +
>
> Comparison style
> ----------------
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 79e759aac543..77f577535fc3 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -3140,6 +3140,49 @@ sub process {
> }
> }
>
> +# Check Fixes: styles is correct
> + if (!$in_header_lines && $line =~ /^\s*fixes:?/i) {
> + my $orig_commit = "";
> + my $id = "0123456789ab";
> + my $title = "commit title";
> + my $tag_case = 1;
> + my $tag_space = 1;
> + my $id_length = 1;
> + my $id_case = 1;
> + my $title_has_quotes = 0;
> +
> + if ($line =~ /(\s*fixes:?)\s+([0-9a-
> f]{5,})\s+($balanced_parens)/i) {
> + my $tag = $1;
> + $orig_commit = $2;
> + $title = $3;
> +
> + $tag_case = 0 if $tag eq "Fixes:";
> + $tag_space = 0 if ($line =~ /^fixes:?
> [0-9a-f]{5,} ($balanced_parens)/i);
> +
> + $id_length = 0 if ($orig_commit =~
> /^[0-9a-f]{12}$/i);
> + $id_case = 0 if ($orig_commit !~ /[A-
> F]/);
> +
> + # Always strip leading/trailing parens
> then double quotes if existing
> + $title = substr($title, 1, -1);
> + if ($title =~ /^".*"$/) {
> + $title = substr($title, 1, -
> 1);
> + $title_has_quotes = 1;
> + }
> + }
> +
> + my ($cid, $ctitle) =
> git_commit_info($orig_commit, $id,
> + $title);
> +
> + if ($ctitle ne $title || $tag_case ||
> $tag_space ||
> + $id_length || $id_case ||
> !$title_has_quotes) {
> + if (WARN("BAD_FIXES_TAG",
> + "Please use correct Fixes: style
> 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid
> (\"$ctitle\")'\n" . $herecurr) &&
> + $fix) {
> + $fixed[$fixlinenr] = "Fixes:
> $cid (\"$ctitle\")";
> + }
> + }
> + }
> +
> # Check email subject for common tools that don't need to be
> mentioned
> if ($in_header_lines &&
> $line =~
> /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
next prev parent reply other threads:[~2022-09-11 15:38 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-10 8:38 Niklas Söderlund
2022-09-11 15:38 ` Philippe Schenker [this message]
2022-09-13 6:41 ` Dwaipayan Ray
2022-09-13 6:58 ` Lukas Bulwahn
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=7b2159922e989b1a5d5a3662fddb3c5ee2a97761.camel@toradex.com \
--to=philippe.schenker@toradex.com \
--cc=apw@canonical.com \
--cc=corbet@lwn.net \
--cc=dwaipayanray1@gmail.com \
--cc=joe@perches.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=louis.peens@corigine.com \
--cc=lukas.bulwahn@gmail.com \
--cc=niklas.soderlund@corigine.com \
--cc=oss-drivers@corigine.com \
--cc=sfr@canb.auug.org.au \
--cc=simon.horman@corigine.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
all inboxes | Powered by JetHome®