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] checkpatch: warn for non-standard fixes tag style
Date:   Mon, 29 Aug 2022 17:53:58 +0200
Message-Id: <20220829155358.2546732-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?UWFoVXlIalNYMXAvdlhnbVcwQnFrUTAwZVk5Y1RyVnVIaUtEeWlUc3BoZS8y?=
 =?utf-8?B?MTRlZjdJcU84MURVRmRyYjRsRENwOUxuMktMbkFleTMzcCtuNVVsdmszbFgx?=
 =?utf-8?B?QUd2MnNqS1VwMU01Z3MvNkVVTEVodUdibVpxSHlTRVNmRzZzODVrNFhhMDJU?=
 =?utf-8?B?VHZVa05BUEFxa3lBZ0duQU9uZVVVbzlNaDFkbzNCaGZHdmpKMnRzcU9IdjhQ?=
 =?utf-8?B?K1ZwbWVKVHNvTDlPNXZaeWhMem0vY3kwOFY2c1BXbSs4RFN0VmhSV1dObTV0?=
 =?utf-8?B?dTdCMFNUY0ozMU5CSmQ2d0p5YlFhck91ZytDcWNRd24zV25Zc29KLzRDYkpB?=
 =?utf-8?B?VWNvZmIyMGVxL1hSeU5iVS9jY2VZN1ducTRXa3AySGpGK2t0dmxSVGRRdjBQ?=
 =?utf-8?B?ZnVlZnpnNExMQnVjaEJVMkZXYnNudXNkbElrcVdkRWFPRmR0b2xnMW52TEFP?=
 =?utf-8?B?RVd0YXRLbXZpKy9RM2pqRXQ4UUxOalNFSWhxNG85T3ZJd1Z3MkR4TTlPTVFs?=
 =?utf-8?B?bDhjYzA1RFV4Q0VaNWJreW9YbmI0NG5pR2J6MG4vMVV5WGJ6TVRqRjc2TWll?=
 =?utf-8?B?ekUyZXhxTm9jVUR3TFJZWHVJK1VmRCtKRmN3WS80S1g2UXVWU1hOTGZqYzZD?=
 =?utf-8?B?VXdRd29Jb2hmeU4wd1pNUEwvNFZCSDBlbHoxMjBPVCtkWlFLZXV4K1FMTlZi?=
 =?utf-8?B?SEFVTVZqN1NRd3RRRFNWeWpLbnhIUVBPVCtDUkFWaU5vWFBOaWJia1J6b3Jm?=
 =?utf-8?B?T1hOZ0RJS2RtM01YQkFOWG9rNWNuRXR2YmZiVUxzSGorRnRtRmNzTmpYYlB1?=
 =?utf-8?B?cTJkaG5DZkxOcFBaSEhJSGpYUmJaRnpRdlE0VnFSdFN4eE9hR1ROQTRDV0Nk?=
 =?utf-8?B?cFMzb3M4OHFTcVEveXdVUlQ5bDJLb0JETU1yT3VZV3VESHdmREdCS0ZueXV5?=
 =?utf-8?B?ZUh2TzMyd0tCa05Bd1VZRFZjcDlxRjlPWGkrdkFWUjdiUUhaNis3ZXJuK0g3?=
 =?utf-8?B?RktrU0RBWVhnTURtMDJDcmIvZ3JYQ2RKTWIwbmlZUXlMZXlaWGhOVEtXbjU0?=
 =?utf-8?B?MEhFeFE0MHNOenkzblFLYnh0Y2hweXVMNDI0Y3VOYk1PdWcwYXB3U1UwSGxn?=
 =?utf-8?B?RjMrWk5RWTNnUmVXVGd0clRHNlVvVXhwc0UzRldTb0Uvcmt6dzRjRzFyQXpj?=
 =?utf-8?B?OEJSc3NBMDczQzFOSG1HNlQ0b1RzMUhNcDJkNTVDVkhhOERqUXZyNkZZTkJp?=
 =?utf-8?B?eUJpSkR1bk5NV2tic2VUYWZrVk1EUytHNi9IVWM2Y2xSQ25WRHIyTHcxNWdM?=
 =?utf-8?B?L2I1TDdIbWM4VHlyZXI3R3hhM0VXSVo5SE9hRU1CbGcvYmR1eEN4a0JpaWNZ?=
 =?utf-8?B?SmM0S2JMU3UvNU1zU3lkQURlSmNoZkg4RWtEUjdudkpXd08zSEFZbHBoOTR0?=
 =?utf-8?B?N2Zhck5WZ0pocDd1R1ZBWWxRSWQ2YW5FMTVLems5TkxqeXp4M29wWmhqUzBI?=
 =?utf-8?B?ZWhyZmJrM3VQMWRvVmFsd1kydVBuSHRkZkYzMFRBOVVRZTdSN2ZxTy8wUnN6?=
 =?utf-8?B?a3lmQU9GUDFiK3hDSTBKLzBnRlVMVXorR2ZMSkFCaUtuUzhhbFZwZW9OcXBS?=
 =?utf-8?B?RUxGRjIwV3pNU3B5Z1poRC83Y3h3cnJvZCt5WEV1OTNnSUZlWEptTGhlSGZs?=
 =?utf-8?B?TmRyOXZ0K3hCWVB4bTlEdVZvakFWcEd6RUFYL2FMVThmTDk4NmZXa0t4SjVY?=
 =?utf-8?B?YUZNeVVVZnhRRFBKM3ZTcXlFSmxCOG91TUpTUmt1NUtVWmMwWHdsVkRZclYw?=
 =?utf-8?B?SEVzaXc1b2pmdEZtU1ZEa0d1a2dZZ21vUGpmck9PUXhpbTVwT2dhdDNORFYx?=
 =?utf-8?B?bXZJM1JjOGlKNHArOEU4QURUd2ZlR2FrQWtQcnVqNS92Qk9tRGI0WXI5UTVS?=
 =?utf-8?B?RTFSNG9yVDFpRlQ1Y01OOTFrY3FWdzBvbHNaTHlKcncwVkxhbXVETC9lWFRn?=
 =?utf-8?B?QWxzM2k0U2JCOTAwS09mejVVZ284VWRnbnlkNDNiTEh1QmlHS2xIYVpva1hy?=
 =?utf-8?B?V1JWU3VXNmdLVGVqbkhEMWxZTUdqNDUwNnlxYUpOb2NWVVpyRTJZSnlNMHZL?=
 =?utf-8?B?VFY4RVN0T3lvVjF5MSthckVNSXYrNVl6K2VJaG9ONTBKODdyOE9oNEFjczVE?=
 =?utf-8?B?alE9PQ==?=
X-OriginatorOrg: corigine.com
X-MS-Exchange-CrossTenant-Network-Message-Id: dc920175-50e8-438e-e23a-08da89d6b95b
X-MS-Exchange-CrossTenant-AuthSource: DM6PR13MB4431.namprd13.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Aug 2022 15:54:15.3253
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: fe128f2c-073b-4c20-818e-7246a585940c
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: EotWf5x9gvek1PczoXnKjtBdSyf1GDiQYQDT2E9LMuvVEK/TfpZoQu63GFAQKzEwO2fQXOYWos+g/2aVYZy0zCjaEtLEuRH8YDYL/EOaCM0=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH2PR13MB3605
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>
---
 Documentation/dev-tools/checkpatch.rst |  6 ++++
 scripts/checkpatch.pl                  | 41 ++++++++++++++++++++++++++
 2 files changed, 47 insertions(+)

diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index b52452bc2963..8164f362a2fc 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -612,6 +612,12 @@ Commit message
 
     See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
 
+  **BAD_FIXES_TAG**
+    The fixes line does not fall in line with the standards specified by the
+    community.
+
+    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.2