Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   =?UTF-8?q?Niklas=20S=C3=B6derlund?= <niklas.soderlund@corigine.com>
To:     Dwaipayan Ray <dwaipayanray1@gmail.com>,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>,
        Joe Perches <joe@perches.com>,
        Jonathan Corbet <corbet@lwn.net>,
        Andy Whitcroft <apw@canonical.com>, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org,
        Philippe Schenker <philippe.schenker@toradex.com>
Cc:     oss-drivers@corigine.com,
        =?UTF-8?q?Niklas=20S=C3=B6derlund?= <niklas.soderlund@corigine.com>,
        Simon Horman <simon.horman@corigine.com>,
        Louis Peens <louis.peens@corigine.com>
Subject: [PATCH v4] checkpatch: warn for non-standard fixes tag style
Date:   Thu,  8 Sep 2022 18:44:34 +0200
Message-Id: <20220908164434.122106-1-niklas.soderlund@corigine.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?cHFYTVJDL3U2bFRSL0wxWkxvaHVEbkJFSklBZnNvcG9NanFFZHp6am9XY0lO?=
 =?utf-8?B?Y1cwL0szZi83QkMxV2lITmdHNCtjTkpRRkVGQWh6M24xNWdkSjF6bEw5ZmQz?=
 =?utf-8?B?NWRYcldsZXF3UC95VzFLQUhQSFpPdEFyZWt0R3pNdlJpNUJibXRhQVZ5MmRl?=
 =?utf-8?B?cHNDR3cxcE9VdTFmakdDK0FncmY0dmxlUEYyTHpja0ZWUG5JTnN3ZkRxNXpW?=
 =?utf-8?B?bjd6ZGMvYi9xai95TFlUWkFxS0hGekwwTjNNVk4yQVV2a3gwbTA4NXdZZi9n?=
 =?utf-8?B?dUJtY3BCWU5Va2FpRUtveGtuNi8yTC9XTU9QdTJhVzl1UmtYWXBGR0pValRF?=
 =?utf-8?B?QnErYmdJTVp6SElVOWdJVHJtaXZOUnFiS2JQTHo4SnNSUWVON1ZrUnBkYUoz?=
 =?utf-8?B?K2tkTDdxVmhnOXhRSjd5aU5YWkFySEtSaS9vSEZqLzJ6WVJvNjkvU1NnTTA5?=
 =?utf-8?B?QTQxcWp6MjBnMlh3M2tMQmdFM2YxTnEyNk1DSlJJZVhwLzhOWmNuRnBwcVRY?=
 =?utf-8?B?akxkbzZlNWw0d05MSjBYK05sbE1SbTBjOFdiNTJhc0NTUjdxTENsbTNLM0Rw?=
 =?utf-8?B?cEd2REFGY3VaakpNUlRaU3lxOW1kOFRkWUVBTWl2UnVJQ0Z1T1F4Rmx3b1Jk?=
 =?utf-8?B?dXhkRUdUWUJjQW9Na0lwTUpFNnBTZHZvYzNkaDJlQVB5Wkt1blZRanFnVkdv?=
 =?utf-8?B?T2hjMHozNy8zRmZ6dHA5UUtsNFo1bkJZaGJXcXYwd1Y2NDBzWFI2bDlsSTd0?=
 =?utf-8?B?emY3RDBwUE41T1hwQ0JNNXRKRndVei9DbCthcGpPRElEY25IWDVxTlMvSTZD?=
 =?utf-8?B?c2ViL0NCckxBSlpjTDNIdHhsbi9tWkdqSnFNd3o3YzJoTUZaeWpIaFhLY1Z0?=
 =?utf-8?B?anBrVEg3bFFIMHZLdVo1azlxWUFnVEVLNW93ZHQvSzhnb3lzbmU4RS9mTy9p?=
 =?utf-8?B?OFRzKzNXTHRpa2QrdHd2ZGlDTk5XcHdDR2FLME9rRUhYdTMyWHpxNGZ3OVQ5?=
 =?utf-8?B?TVpZZExqcHJENGVkK2d4Wk5ESHV3TkZlL0Y5OWh2U3laWmJWWmlnMjZLUVor?=
 =?utf-8?B?Ym4vUzJmOWVBZmlDU2FEN1YxZWdCRGlyZGMwL2tRREN5UllEOVc2M3ZRUnhB?=
 =?utf-8?B?WFRjYk4wd0E1ajdka3VzMnVIWUt1NDVBc2NrbEl4N1cySkkxV3hZL2xXNlQ1?=
 =?utf-8?B?T3Z1OWw5OXMreHplTzNIUmZDcm4vaVp4ZDI0Mk5Tam5RL1ViVUhJOENZZ2pG?=
 =?utf-8?B?dkZQWUxJSng3VGhaQUdzRmt5QTNNVGpEM2NBN1ZHaEVXOW1aT0ZiblMrcE52?=
 =?utf-8?B?ekZNcjJzTEFiKzhNWXo5RmtjaE9TbXJoMnhUMTYyL3phZ1VXanhvUnNYSkwx?=
 =?utf-8?B?Tm4rTEhZaEJGM1pBRmhYbWh3bElqUVc4Y3Fha3UySGdITW1SUURXc1E2dFN1?=
 =?utf-8?B?SmV1Ri9PeDA5T09RV243TlFqNEY2MjRocStYdDZSbGdtVk0xR2pwSHh6aldP?=
 =?utf-8?B?STNRS0NoNHc4YWRkZWR5cEJvVERRQmVUU0FFWW5vcUIvYmg3dS9vNm5NVW9z?=
 =?utf-8?B?UzYzaEdXWklxNytkem9Ncmg2ZEFuenNaV0l1U2pkbU8yYW93SERQcTRSUHh0?=
 =?utf-8?B?Z3BBQjF3RElXL1VCM0hqSmx5OUtqNWpyZmhBZFdJZjFQcmV3ZWNvamNHSmRJ?=
 =?utf-8?B?ZWhva1BKbWhEc2ZVZVBxS1JTVTVkZnc5QlhlREVVSnJHRUJVQmxqMDdIV0dT?=
 =?utf-8?B?NUtIeEFucDBySEkzL09DNk9oY1VzMVkwd3VzTDdENitTa3liYWVndGhqazVP?=
 =?utf-8?B?NjhPTlgyR3MxampQVzFMR2d2Z3BLTXdwMmhjbDVValFLYS9wTzQ1MGc0OHlW?=
 =?utf-8?B?TG16NEk0eVJ6Vndjd1ZPVEVtVUVhUERqSGRhNDVwTmE1NmhzSnYxV2xPcjVZ?=
 =?utf-8?B?ZnRUSkVEaG5udTcyeDgzSUJKdkdyWkJ2NXZHeUEyQWJqVzArY0hLQVpyRTRy?=
 =?utf-8?B?RWs0b1ZiMmpIWi9mT0RPUlU3U1d3TmxsQnl2YWQxODBQTnpkTE4vb1A4VTVw?=
 =?utf-8?B?alFqY29yQ0ZNZXh6eHBEc281WW91akwzTmVqbG1yZkszVU1SanplVnlWRVlv?=
 =?utf-8?B?K2lmMERaWFJCTklTdGl2VXg1NHRFWHlHaGp2MEZSaitUdTdmdm9xT2E4VVhq?=
 =?utf-8?B?RFE9PQ==?=
X-OriginatorOrg: corigine.com
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY3PR13MB4978
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,RCVD_IN_DNSWL_NONE,SPF_HELO_PASS,SPF_PASS,
        T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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>
---
* 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
  fixes 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                  | 41 ++++++++++++++++++++++++++
 2 files changed, 49 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..ac7ae2e4a1d8 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3140,6 +3140,47 @@ sub process {
 			}
 		}
 
+# Check Fixes: styles is correct
+		if (!$in_header_lines && $line =~ /^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 =~ /(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) {
+				WARN("BAD_FIXES_TAG",
+				     "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr);
+
+			}
+		}
+
 # 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) {
-- 
2.37.3