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>,
        Stephen Rothwell <sfr@canb.auug.org.au>
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 v5] checkpatch: warn for non-standard fixes tag style
Date:   Fri,  9 Sep 2022 22:25:34 +0200
Message-Id: <20220909202534.1857709-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?K3laSXJzRm1XZVFoTldYQ21mWTdKS2dGRUFXZ3hYSWwzSU1pWHpaOEkyM3hi?=
 =?utf-8?B?eTRhWUJ3K1RqM1NzdkpzUCtDRStVYVRIakdQL1VyMHBTZnR4OGRPWlRyNG50?=
 =?utf-8?B?T3NKUjlORGIwNCtwM2NWeCtHSVBwai83elJoQmIwTHR5dWttcHhPKzhGdEJl?=
 =?utf-8?B?NFJUd0Q4Y0NPNjVZeGY5WTFOWFB2WVNSWkJOQzJLQkNuVEM2Z0hHWHdVTnBV?=
 =?utf-8?B?bEpQWTIrd2gxek5qZ1dOZzB3YUVjV0RPQWh5VEtla1hkNUtVNkkvT2xlcnRn?=
 =?utf-8?B?Y0lid0c0eGRCdmFwaytWUlg5dkQwMHQvdWE5SWxkUmt5ckZ0Zk00Z3R5dmI5?=
 =?utf-8?B?R3JtRUtlMGxKbnltNDdiQ1NJeitYbHllcW9idFNlWHNMN3U5dXpTbDAyMjE1?=
 =?utf-8?B?SHBiamkwbndnS21oVlEyK3lTQU4rckdDOGNhZ21XRjR2dlJXVmptNHpYdTdq?=
 =?utf-8?B?THZ1WURQR1hDc0pMclRWV280alJKVzZhaUR1a3BCUW52NTFrYkc4ZGlsMHU2?=
 =?utf-8?B?TWVwR2hJWUs4Wk1zNjdpV1lQYlFCOXFVUzhYOGZ0VGtNRkZqK2hZU2R5aDg4?=
 =?utf-8?B?bGI0U25qbGc5U2ZocDRyNzkzaEJqNjZFcTJGeUhwazM1TEdsOFFNdmlYZ0Mx?=
 =?utf-8?B?bXU3N0ZzYXR1RU14c1dCRXZoV0RaSlZmNEsxYnhibGhpbFNSUWtyeldwTE1Y?=
 =?utf-8?B?TUk4ZDc3VXVoQ2FSS1doOXc2cXBCK0RnNEJjb0dzTURYekR4R2YvRDQwOUcr?=
 =?utf-8?B?M1kreDZwbDVobElTUVpZbkFZaHZBR05lOWZ5enNRZE45U0VCR2l0TzAzV0dQ?=
 =?utf-8?B?WmdSN1prWmlFRnl1NkVPcUdaMkViZHdSV0hlbTBhL21Cb0VaVXhlTC9MelVD?=
 =?utf-8?B?eW1JV25xWEFsYnhHaWJhdmhuMDR1WmxqVUlBeU5oZ1I1RC9mODJsbzBlRk4z?=
 =?utf-8?B?Nzg4ZjhnNjVjR0dCTHVHbWhFTS81U1g5NlhndEFCcFRJT294NUpVWFprSG44?=
 =?utf-8?B?SGJDQ2V6eTJOSW1DVTZhaWIycFBUVEIyb3U4aTFDcW1wY0E1RnN1R0F5eURs?=
 =?utf-8?B?QnNLRmdYWHpvQ05ta0tCVnN0UXI5d1E3RkYyT1BTQld0Y2hZZ3J6ODd1bGJw?=
 =?utf-8?B?akVybzV0ZFF0QWlTeXJZaHZBbVZremtkUmpucjk5LytBUG9hbm9yc3M1amQw?=
 =?utf-8?B?M2JUWjV0VWFISmh5N3laMWY4L3NjREFkUTBBSEZBMDUxNXFIRkZUT0hXTktE?=
 =?utf-8?B?Z0lrRlJHYmRXYWRQUGtIQUVXTy9URTZvS3A2YlUzWmNZR0RSdXQ3KzB1cjZ1?=
 =?utf-8?B?dnMreWJzSW4xbk05ZFNseVQxWDlGY1YwV0RiSTdzR1pqNU5PanNIV05JYlVj?=
 =?utf-8?B?dVQySk16bXBlYzQ5eGhBMnA5K0NERUliVDdhamtiN2pBeExUMXF3K2YrNmlz?=
 =?utf-8?B?ems4eVJaZ3F2a1JvYjhZQ3Y2V0laS2haWWhHZjVyOXV2cFZic2gxODBmc2dn?=
 =?utf-8?B?Nm1yV0lyR0RnUkFNWVVlZjFWRDlpRHZFUEt1dGtPbEl5OG1tb3cxalB0VTRD?=
 =?utf-8?B?NXltODJwWDZ5U2lMem01MTNadlBpMjZjcTFuZVZqZ25xYjVHOTBwMFd5T3l3?=
 =?utf-8?B?amlLMi9VTnE2bDBQWTB6dGpaeG1EUDFrYWFzVmJIYnAwd1FtMlFqU29IQ3ZM?=
 =?utf-8?B?ak5FWXhlOW16bzRiRGxhVTJKRW9oRlFMMUkyd05QRGQ0QlVoUnB1ZjRtRit6?=
 =?utf-8?B?WHVXS0pqTUUvLzhxNGVhQzdWRFo2L0F3NW4xcXcrMFFTUVg4WExydlFJSnlE?=
 =?utf-8?B?Y0FtYndaYXA5eUF3Q2JORVkzeWp2blZWUU1wb2laQjV2aXNvV1FKVUlvU0JL?=
 =?utf-8?B?TXB6dUFMOWxWQlptbHJVbzBGQ2ZMSGFWald3VWN1b1RVRHRJTlpNQ3Z2bWZa?=
 =?utf-8?B?WFF6cWltdTNNbFIzd1ZzVDVPRUNBam1NMmRLdm9WMWlJRE9rOTZHcGRubFVY?=
 =?utf-8?B?N0tYTmhoV1lmd0Nlek1oY2Z5TU1lL25ML1BwdVB0RG5rcGhGUTlPbmxvVVNR?=
 =?utf-8?B?TCtkdm9TUzVLOG1Ndk5UOTE1dk1aSS9RUnNWUFRSZ3U4NmxCWTN1RkdaNUZG?=
 =?utf-8?B?bSswajl6UTZuQkRuemNPVFB4QTZ5UEdnVkNQU0NaUGJVL0I0YWpmazlJYzha?=
 =?utf-8?B?WWc9PQ==?=
X-OriginatorOrg: corigine.com
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR13MB5426
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 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
  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..61db5a46e254 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 =~ /^\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) {
+				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