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 v6] checkpatch: warn for non-standard fixes tag style
Date:   Sat, 10 Sep 2022 10:38:35 +0200
Message-Id: <20220910083835.2219239-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?Z2QxR1Q4R0ZEQS9QYlJ2SHAyNlpnb0NoSmV6c2x5OEJITm1QRlhMRXRJVWlh?=
 =?utf-8?B?SjlKUCtRdExDNGZKbjdEZlVKWHRMNTNvLy9MSllZenlzek1Vb1IzVzA1SFBn?=
 =?utf-8?B?OEVHQUpvUGp2aVdCN0VGMklHQ08vbW9OU24xMEkyY1lXOURQUHBnaFk3VUJ4?=
 =?utf-8?B?S3hVd1ZqalVobGFIMjIrME1ZT011SnA2Sk1OYzc2WmFnamdPYTNnb241ZThw?=
 =?utf-8?B?R09mcGtNNFN0eWpGaTczWTQzZmNoUURlY1pWc0l5TldWRGZDeU1ZbFpPOGMv?=
 =?utf-8?B?NGJ5WUhwMy82TUpRaFdRK0dWaXNYM3o4S3l3VktUVmFnZUtnUHFlNy83bVRY?=
 =?utf-8?B?TU5FMklDcU5vN0cxdWdqbGNHN0JHdUJwZUJOazFkNlB4T0hNYkZjSkNCK29n?=
 =?utf-8?B?WWJDazl3RU5lbDdzandlNlBzRVBvMFhwUHRZQk1TY3R4M0pmT1NpWTR1MkxX?=
 =?utf-8?B?V20xVGZxbE9IT2RXMnpUOEZwczFCcHZjNExQZDNaMTVob3c4Vjg2S2EvaGFR?=
 =?utf-8?B?enN4ZXB4OW5qSWRPLy9tOVF6Ry9RYXdhaEw5U2JOVGp3NmluZXpSVE5EOEI4?=
 =?utf-8?B?TDJXWG5CLzJuZ09hYlI4VkUxM3VKSXMxaW1ZaG1Pc3pmZ3lacjJBTVNoRWlP?=
 =?utf-8?B?MTAvSnc1dWsxNDRFUUxxL0hZZDh5MnpMU3F0NmJjaUNXd0xBYkVxaWd3OEp4?=
 =?utf-8?B?dmpzTkg0MWtlbkFHY0dNUkprS3BNWFRnOXJCNXZ2NUIreHlINzZoeGltMFA2?=
 =?utf-8?B?Yml4TWRaVk1hdzhhbXR0MjZxL3g1cDNXVHY3YVBQTk9xWGo2U3pmTjdqbWF0?=
 =?utf-8?B?TWJITHNJSHgybnFPN1A1UDRBRExaekFINitmVXp0WFhGdm43eFVBTThIb0Q1?=
 =?utf-8?B?UzlTM3ZORU43QWxURlRQZ3EwTHlrZjRNdlVoR0lIU3d5YmpZU21yWEVhNC9P?=
 =?utf-8?B?ZVpyaFp3dnkzTGxTMDFaMXhtdjgrcGtGTzd5MG9vNHNmUkEyaDVTTytwVWRo?=
 =?utf-8?B?REIya2RGWlJhaFNjbC9rM2xqNmZvY2JhZ3NoM0hCcVV5VzNQQXlBYmNIN2xa?=
 =?utf-8?B?YitqVXIzUWVIWHRxczVhbTRHQ0l5QURadFVZeWo1WDNNY3FRdXZVYTlFbTZH?=
 =?utf-8?B?UkZkc1FESDZSQWZ1SjQvK3JIRG8ybUkwaVR2bmdPMXE3QkEvZWh2eUtyeUVs?=
 =?utf-8?B?VFRDUGl5aWlHcU1CRy83OWcvYklPdVFLSDFBRWM2NWRtNG03a3R0VmhCd3J6?=
 =?utf-8?B?bUE5OUpQZllYMVVLV3JCdEw2ajhiVEcrSFozOUd2VUR0T0diNWY0amtTLzNh?=
 =?utf-8?B?NERwdVcxM3NMNGJlOU81NzlJTXFOS1JveVVTeXAwS3lhenBVbllXMjUyL1Y0?=
 =?utf-8?B?c1FINW4yL0FYNHljY0JpSC9yWHE0ZksvQlJzUXFJaG8rVVZTcW9HZWtGNVBS?=
 =?utf-8?B?TkM4QUY3TC9HblFxZG4ydGxLdHNnMk1lYzZTR1RsRmM0Wnduc0dpUU9oUS9L?=
 =?utf-8?B?MzdLK3RxRmg1amFJWUdyTDdCQ0wrMHdid2d3V0c3RXRUWW1XOUlkMk8wSVdW?=
 =?utf-8?B?bWFKQzhWb1dWd2tkc0RmdGpKYzFTTXRjbjRRU0Zralh5UGhVZkdWd1VUQUtQ?=
 =?utf-8?B?UXR4ZUlpb3VaR0s5QldtbDMrYXYrcUxaUHNWTFNqSzVKZnR0QnBUQTFBcU5W?=
 =?utf-8?B?bG5SWmg1QkRDSTJmak5GRWx3SWYwZnQ4OXFsTUxZYk9EUzloUGk4b1pnQUJE?=
 =?utf-8?B?SjVHM1FQZ25YZGxRcmFWN3k0RmZDU3c4S1ZrRGdDWmgxeWF5ZmxKUlQzOWZi?=
 =?utf-8?B?aURoMC82c0gzWFFaMmsrUDVNeXBQcTd6UEZabXdTMFJ5bEMxSzBqSkpCaXJo?=
 =?utf-8?B?SE9KbmhsWUU3MWZGZ3BpVUtQN055T3dLUENMZUplYmxZazJQK1VlS0dGZ1Ax?=
 =?utf-8?B?L25TdXZzUWVKYXNQZllyWVpNOXI0VnllekFvRVdkaU9ub1NCZjRvd0RUYjJz?=
 =?utf-8?B?bWYvV2VrbkxDamRlK2RHbmhoOTRwWUUwSjYzUjBhN2pZTVZ2VE0vRG5ud0V5?=
 =?utf-8?B?cjBnL3pHZWpiRGNjc3NFeGJoNXZMeDRuZDJiMUtISHlDVk16YzUyM2MyeGZE?=
 =?utf-8?B?d0RlUzAzaDZ0T1lodzhQNVR1UUJmWHZnYzUrcEErdTcySmlTYlk3QzFBckJy?=
 =?utf-8?B?SGc9PQ==?=
X-OriginatorOrg: corigine.com
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL3PR13MB5075
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 v5
- Add support for --fix option for checkpatch.pl.

* 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
  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                  | 43 ++++++++++++++++++++++++++
 2 files changed, 51 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..77f577535fc3 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3140,6 +3140,49 @@ 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) {
+				if (WARN("BAD_FIXES_TAG",
+				     "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) &&
+				    $fix) {
+					$fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\")";
+				}
+			}
+		}
+
 # 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