From: Aditya Srivastava <yashsri421@gmail.com>
To: joe@perches.com
Cc: yashsri421@gmail.com, lukas.bulwahn@gmail.com,
linux-kernel-mentees@lists.linuxfoundation.org,
linux-kernel@vger.kernel.org
Subject: [PATCH] checkpatch: fix false positive for COMMIT_LOG_LONG_LINE with URLs
Date: Thu, 17 Dec 2020 19:12:21 +0530 [thread overview]
Message-ID: <20201217134221.16178-1-yashsri421@gmail.com> (raw)
Currently checkpatch warns for long line in commit messages even for
URL lines.
An evaluation over v4.13..v5.8 showed that out of ~11000 warnings for
this class, around 790 are due to the line containing link.
E.g. running checkpatch on commit 3cde818cd02b ("ASoC: topology:
Consolidate how dtexts and dvalues are freed") reports this warning:
WARNING: Possible unwrapped commit description (prefer a maximum 75 chars per line)
https://mailman.alsa-project.org/pipermail/alsa-devel/2019-January/144761.html
Avoid giving users warning for character limit, instead suggest them to
prefix the URLs with "Link:"
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
scripts/checkpatch.pl | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index abd5a3d2e913..23da1f50fe6a 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3032,8 +3032,14 @@ sub process {
$line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i ||
# A Fixes: or Link: line or signature tag line
$commit_log_possible_stack_dump)) {
- WARN("COMMIT_LOG_LONG_LINE",
- "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
+ if ($line =~ /(?:http|https|ftp):\/\//) {
+ WARN("COMMIT_LOG_LONG_LINE",
+ "Consider prefixing the URL with 'Link:'\n" . $herecurr);
+ }
+ else {
+ WARN("COMMIT_LOG_LONG_LINE",
+ "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
+ }
$commit_log_long_line = 1;
}
--
2.17.1
next reply other threads:[~2020-12-17 13:43 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-17 13:42 Aditya Srivastava [this message]
2020-12-17 17:03 ` [PATCH] checkpatch: fix false positive for COMMIT_LOG_LONG_LINE with URLs Joe Perches
2020-12-17 19:35 ` Aditya
2020-12-18 12:11 ` [PATCH v2] " Aditya Srivastava
2020-12-24 15:19 ` Aditya
2021-01-14 7:35 ` [PATCH v3 0/2] checkpatch: fix false positive for COMMIT_LOG_LONG_LINE and provide fix Aditya Srivastava
2021-01-14 7:35 ` [PATCH v3 1/2] checkpatch: fix false positive for COMMIT_LOG_LONG_LINE with URLs Aditya Srivastava
2021-01-14 7:35 ` [PATCH v3 2/2] checkpatch: add fix option " Aditya Srivastava
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=20201217134221.16178-1-yashsri421@gmail.com \
--to=yashsri421@gmail.com \
--cc=joe@perches.com \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--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;
as well as URLs for NNTP newsgroup(s).