From: korantwork@gmail.com
To: apw@canonical.com, joe@perches.com, dwaipayanray1@gmail.com,
lukas.bulwahn@gmail.com
Cc: alexs@kernel.org, linux-kernel@vger.kernel.org,
Xinghui Li <korantli@tencent.com>
Subject: [PATCH] checkpatch: Add the backport commit format check
Date: Mon, 5 Dec 2022 17:48:26 +0800 [thread overview]
Message-ID: <20221205094826.44844-1-korantwork@gmail.com> (raw)
From: Xinghui Li <korantli@tencent.com>
The backport commit has been used to be misreported as Error
by checkpatch.pl like this:
'ERROR: Please use git commit description style
'commit <12+ chars of sha1> ("<title line>")' - ie:......
commit <sha1> upstream.
total: 1 errors, 0 warnings, 8 lines checked
'
So, add the backport commit format check to avoid the above mistake.
Signed-off-by: Xinghui Li <korantli@tencent.com>
---
scripts/checkpatch.pl | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 1e5e66ae5a52..92ba39418239 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3252,6 +3252,10 @@ sub process {
# A correctly formed commit description is:
# commit <SHA-1 hash length 12+ chars> ("Complete commit subject")
# with the commit subject '("' prefix and '")' suffix
+# A correctly formed backport commit description is:
+# commit <sha1> upstream.
+# or
+# [ Upstream commit <sha1> ]
# This is a fairly compilicated block as it tests for what appears to be
# bare SHA-1 hash with minimum length of 5. It also avoids several types of
# possible SHA-1 matches.
@@ -3278,6 +3282,7 @@ sub process {
my $herectx = $herecurr;
my $has_parens = 0;
my $has_quotes = 0;
+ my $backport = 0;
my $input = $line;
if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) {
@@ -3307,18 +3312,21 @@ sub process {
$long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i);
$space = 0 if ($input =~ /\bcommit [0-9a-f]/i);
$case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
+ $backport = 1 if(($input =~ /\bcommit\s+[0-9a-f]{12,40}\supstream/i) ||
+ ($input =~ /\B\[\s[Uu]pstream\scommit\s+[0-9a-f]{5,}\s\]/));
} elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) {
$orig_commit = lc($1);
}
($id, $description) = git_commit_info($orig_commit,
$id, $orig_desc);
if (defined($id) &&
($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) &&
- $last_git_commit_id_linenr != $linenr - 1) {
+ $last_git_commit_id_linenr != $linenr - 1
+ && !$backport) {
ERROR("GIT_COMMIT_ID",
- "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx);
+ "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\nor check the backport commit description format\n" . $herectx);
}
#don't report the next line if this line ends in commit and the sha1 hash is the next line
$last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i);
--
2.27.0
next reply other threads:[~2022-12-05 9:48 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-05 9:48 korantwork [this message]
2022-12-05 12:39 ` [PATCH] checkpatch: Add the backport commit format check Joe Perches
2022-12-05 13:11 ` Xinghui Li
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=20221205094826.44844-1-korantwork@gmail.com \
--to=korantwork@gmail.com \
--cc=alexs@kernel.org \
--cc=apw@canonical.com \
--cc=dwaipayanray1@gmail.com \
--cc=joe@perches.com \
--cc=korantli@tencent.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.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