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
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 v2] checkpatch: warn for non-standard fixes tag style
Date:   Mon,  5 Sep 2022 12:52:47 +0200
Message-Id: <20220905105247.920676-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?eGxDZXNzNHpMN2syNlVQR2kxNDdpMFlWb0t0SVRkM0RmVitaRmRvMk91UTFp?=
 =?utf-8?B?U0taaFZnQVJPbjEyU2pRcXF4dHFwYkFXNjlvd20xc2hXdXJVMVlyWGtUb054?=
 =?utf-8?B?UStGVlI5NklaMDJVa0dWR2tGTUxRTWVGUEpPRnFGL2ltSjZ2bGZZTTZ1czZP?=
 =?utf-8?B?VFdYb01ROGZXM1puR0NDSjNCbUprQ3FPeVk5SyszU1pLN05IU04vZy9vVElt?=
 =?utf-8?B?VW1ndkthMVQ4ekFUVXFyaVlSbDhFOFhqRVR1SjdBUHhETE1QcjhyaHdDZ3E3?=
 =?utf-8?B?b0RDY3ZNMExsbTVwVG8weisrd3YzOVNyRTQrblpid09xbWhBaTE5cVhlRm9h?=
 =?utf-8?B?VTZCS0ZhRXVtZllYa1ZYcjhraGJIb2xzRVl5bThIR0I0MjdNTXdIeHBlT3ZN?=
 =?utf-8?B?b1VqeHBaTk55OEt6cHAwOXc2WWppOGYwMUU4OUZxQVNrbkJjRGY3SmhQY2lB?=
 =?utf-8?B?bkFSZCtsVDMxWnFCU24yTWF0L2FCTkVKLy83Y21LdWtwYjUyM25uSUFZMkV0?=
 =?utf-8?B?L1p5dVEyNTdUNHA2Y2RYMFJVVW1JT2RKcUtzMFE1bEZYL1pXYjk3bU82eUZx?=
 =?utf-8?B?YTAxcFpZR2ZXbXllRTlkNVk3RTRMcWdiQTgvcnY3WGNKS3NwbmpiUXBJT1o5?=
 =?utf-8?B?UTZOSGp5aXAwS1BnMzZkVlNWWERKdENONEhPR2R3VnlXMUNjYWs2MC9LNE5m?=
 =?utf-8?B?VFlXWU1Tb2puTlRGRUo3ZHEwT0pacXJVSE9YZ1o3RitWeVFPY3AxUVNUNkxq?=
 =?utf-8?B?RlJOR00xVjU5alJlOGthallQQVV6bzFxeHo0Ky9ZS0J5WjRtRnRwR0VxYXY5?=
 =?utf-8?B?NVY0RzVlU21Ob3hpSVhyVmpxUmd6cGpuZnNmNkVlOWVBeEFCTUpTWUNwSXZs?=
 =?utf-8?B?RWpEMUFtaEg4RW9va2tPenJQUGtWdmdzTFRsblppZFM5ZDJ0R1VIemRJS2hY?=
 =?utf-8?B?L3dqcDhnZWhCQlZITnpkTDNCeU8wNERMaVNOYncyd1pFZk5YK1B5R0tkNlNi?=
 =?utf-8?B?MkE3QXhockZvZFYvMGVEUHBWck5vT3dUWmVMZ1BrTTlmYWN0OVkyRUFDOWk0?=
 =?utf-8?B?WnVyWDlqZ3hEelBMOVZ5cTlqR1BjUkNsUkNNYzY5Z0RQM0x6MGNYZHY3S01C?=
 =?utf-8?B?aWVuQ1g4OFhKQUg5Q1VZN2hLdTBESzhiUDdBYkhhc1kzS0xndkFPRmJxT0Yr?=
 =?utf-8?B?Wnp0OUxmQVJBY1k0UFJxV0RtVDFuUERMMUtoR001c1FQU0lWNFVzckZJOEw4?=
 =?utf-8?B?cXZoc2cyWEVRcmIxTXZBZVF2cGxrQXQvTWtZUXB2NVNWZjVjSUpuRmsxRzZD?=
 =?utf-8?B?Mk1ZLzlaLy9VQlVXaWVUamxkcEZEWERrWDQzczVJRWZTTXVsVFdYd21JdHV4?=
 =?utf-8?B?YytoaXpCa01CR003WXRkZ3ZZMkJXS1FFZFc1djhWYXo3d0diZXZVSTQzMFYv?=
 =?utf-8?B?aDJZN2JKa3Vmdnh0aGR5b3BhZGRvR0lucUJNRHlwcjdnS2dxcXFGQUdkQTZV?=
 =?utf-8?B?bGJlVnhTVkdrbmdXek5jOTd3M3VqTEJHRWd2Z1Jod1B2RUsyK29aaThmL2Ux?=
 =?utf-8?B?dW9QRkN4STUwNlJvMFdGWGJJclkzcTRmU0pFTmY4OGZGMklOclgzNUhQWklD?=
 =?utf-8?B?bDJQZ21DMFhPVFN3WlNhUnlxR0YrNUdoeHVpM3dueUFpMGlMY0NJdW5vMWdz?=
 =?utf-8?B?MmR2dG1CczZ6OFZuZ24rODFzckdQWGw5dWJRVGovNzRVMHFoZmRtTTFxZjVk?=
 =?utf-8?B?cUt0WWZDYVI3ZG9TTHZhVkVwSHBiNU5SWkVJUVdheTI3VDQrbHBMaDZXZjBO?=
 =?utf-8?B?MUIxb3hFWkY2OXJ6cXI4aU9taEN4NDVkTmdQaS81Yy95azQzdXFZcEladE5D?=
 =?utf-8?B?ZmtTbFZOZTdablFZR2Z2R0hwYWtWQ05MNjFLcTlWMTJjR2svR3lDUU42YnFp?=
 =?utf-8?B?eUk1Sy91VjZmbDIxa1BYU1hLbUt0cm1DZDhNeEFuTFhTb2t2bms3SDJtRTlj?=
 =?utf-8?B?MW1hRzhsWVlvMjdlYk9CSmNLRSswVTZ5RURBOVErTFNIdVlHVlE0engyLy9T?=
 =?utf-8?B?QlNNclJVK0poSlEvRUkwOXBCd3Y0UlVzYnVoTklmMnI0RHlwWFZIT1hmKzBp?=
 =?utf-8?B?U2VjcnJBS3U5TERTclNzWFFwQWlGNzZ6TnhOcjJnb1RMb09kQzYxTmZQODRh?=
 =?utf-8?B?cmc9PQ==?=
X-OriginatorOrg: corigine.com
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR13MB3803
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,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 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..9b8cdc582fb5 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;
+				}
+			}
+
+			($id, $title) = git_commit_info($orig_commit, $id,
+							$title);
+
+			if ($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: $id (\"$title\")'\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