Skip to contentSkip to conversation

scripts/checkpatch: validate Fixes: tag format and commit ancestry

PATCH Superseded Cédric Le Goater 3 participants 7 messages Jul 23 – Jul 27 Checkpatch

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 scripts/checkpatch: validate Fixes: tag format and commit ancestry

Adapt the kernel's checkpatch Fixes: tag validation for QEMU.

Add a git_commit_info() helper to resolve commit hashes and validate the Fixes: tag in commit messages. The canonical form is:

Fixes <12+ chars of sha1> ("<title line>")

The check validates capitalization, spacing, hash length, lowercase hex, and quoted title. When the format is wrong and the commit can be resolved, suggest the corrected Fixes: line.

When running inside a git repository, also verify that the referenced commit is an ancestor of master.

Lines matching "Fixes: CVE-*" are skipped. The check can be disabled with --no-fixes-tag.

---
 scripts/checkpatch.pl | 70 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
scripts/checkpatch.pl +70 -0
index 03f35e75012c8c7a00b67f036e4befb2ea162d4a..65ca7d4c5e47c6eeb48647e877b8afb573176f6b 100755
@@ -21,6 +21,7 @@ use Getopt::Long qw(:config no_auto_abbrev);
 my $quiet = 0;
 my $tree = 1;
 my $chk_signoff = 1;
+my $chk_fixes_tag = 1;
 my $chk_patch = undef;
 my $chk_branch = undef;
 my $tst_only;
@@ -54,6 +55,7 @@ Options:
   -q, --quiet                quiet
   --no-tree                  run without a qemu tree
   --no-signoff               do not check for 'Signed-off-by' line
+  --no-fixes-tag             do not check for 'Fixes:' tag
   --patch                    treat FILE as patchfile
   --branch                   treat args as GIT revision list
   --emacs                    emacs compile window format
@@ -94,6 +96,7 @@ GetOptions(
 	'q|quiet+'		=> \$quiet,
 	'tree!'			=> \$tree,
 	'signoff!'		=> \$chk_signoff,
+	'fixes-tag!'		=> \$chk_fixes_tag,
 	'patch!'		=> \$chk_patch,
 	'branch!'		=> \$chk_branch,
 	'emacs!'		=> \$emacs,
@@ -441,6 +444,10 @@ sub build_types {
 build_types();
 
 $chk_signoff = 0 if ($file);
+$chk_fixes_tag = 0 if ($file);
+
+my $gitroot = $ENV{'GIT_DIR'};
+$gitroot = ".git" if !defined($gitroot);
 
 my @rawlines = ();
 my @lines = ();
@@ -561,6 +568,28 @@ sub which {
 	return "";
 }
 
+sub git_commit_info {
+	my ($commit, $id, $desc) = @_;
+
+	return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
+
+	my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
+	$output =~ s/^\s*//gm;
+	my @lines = split("\n", $output);
+
+	return ($id, $desc) if ($#lines < 0);
+
+	if ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
+	    $lines[0] =~ /^fatal: bad object $commit/) {
+		$id = undef;
+	} else {
+		$id = substr($lines[0], 0, 12);
+		$desc = substr($lines[0], 41);
+	}
+
+	return ($id, $desc);
+}
+
 sub expand_tabs {
 	my ($str) = @_;
 
@@ -1811,6 +1840,47 @@ sub process {
 			}
 		}
 
+# Check Fixes: tag format and commit validity
+		if ($chk_fixes_tag &&
+		    $line =~ /^\s*(fixes:?)\s*(?:commit\s*)?([0-9a-f]{5,40})\s*(.*)?/i) {
+			my $tag = $1;
+			my $orig_commit = $2;
+			my $title = $3;
+
+			if ($line !~ /^\s*Fixes:\s+CVE/i) {
+				my $tag_case = not ($tag eq "Fixes:");
+				my $tag_space = not ($line =~ /^fixes:? [0-9a-f]{5,40}/i);
+				my $id_length = not ($orig_commit =~ /^[0-9a-f]{12,40}$/);
+				my $id_case = not ($orig_commit !~ /[A-F]/);
+
+				my $id = "0123456789ab";
+				my $description = "commit title";
+				my $has_quotes = 0;
+
+				if (defined $title && $title =~ /^\("(.*?)"\)$/) {
+					$description = $1 if ($1);
+					$has_quotes = 1;
+				} elsif (defined $title && $title =~ /^\(?(.*?)\)?$/) {
+					$description = $1 if ($1);
+				}
+
+				my ($cid, $ctitle) = git_commit_info($orig_commit, $id, $description);
+
+				if (defined($cid) && ($ctitle ne $description || $tag_case || $tag_space || $id_length || $id_case || !$has_quotes)) {
+					my $fixed = "Fixes: $cid (\"$ctitle\")";
+					WARN("Please use correct Fixes: style 'Fixes: <12+ chars of sha1> (\"<title line>\")'" .
+						" - ie: '$fixed'\n" . $herecurr);
+				}
+				if (which("git") ne "" && -e "$gitroot") {
+					my $hash = defined($cid) ? $cid : $orig_commit;
+					`git merge-base --is-ancestor $hash master 2>/dev/null`;
+					if ($? != 0) {
+						WARN("Fixes: commit $hash is not an ancestor of master\n" . $herecurr);
+					}
+				}
+			}
+		}
+
 # Check SPDX-License-Identifier references a permitted license
 		if (($rawline =~ m,SPDX-License-Identifier: (.*?)(\*/)?\s*$,) &&
 			$rawline !~ /^-/) {
Signature · 1 line
2.55.0
#1 lore raw
Quoted 128 lines · Cédric Le Goater

Adapt the kernel's checkpatch Fixes: tag validation for QEMU.

Add a git_commit_info() helper to resolve commit hashes and validate the Fixes: tag in commit messages. The canonical form is:

   Fixes: <12+ chars of sha1> ("<title line>")

The check validates capitalization, spacing, hash length, lowercase hex, and quoted title. When the format is wrong and the commit can be resolved, suggest the corrected Fixes: line.

When running inside a git repository, also verify that the referenced commit is an ancestor of master.

Lines matching "Fixes: CVE-*" are skipped. The check can be disabled with --no-fixes-tag.

---
  scripts/checkpatch.pl | 70 +++++++++++++++++++++++++++++++++++++++++++
  1 file changed, 70 insertions(+)
scripts/checkpatch.pl +63 -0
index 03f35e75012c8c7a00b67f036e4befb2ea162d4a..65ca7d4c5e47c6eeb48647e877b8afb573176f6b 100755
@@ -21,6 +21,7 @@ use Getopt::Long qw(:config no_auto_abbrev);
  my $quiet = 0;
  my $tree = 1;
  my $chk_signoff = 1;
+my $chk_fixes_tag = 1;
  my $chk_patch = undef;
  my $chk_branch = undef;
  my $tst_only;
@@ -54,6 +55,7 @@ Options:
    -q, --quiet                quiet
    --no-tree                  run without a qemu tree
    --no-signoff               do not check for 'Signed-off-by' line
+  --no-fixes-tag             do not check for 'Fixes:' tag
    --patch                    treat FILE as patchfile
    --branch                   treat args as GIT revision list
    --emacs                    emacs compile window format
@@ -94,6 +96,7 @@ GetOptions(
  	'q|quiet+'		=> \$quiet,
  	'tree!'			=> \$tree,
  	'signoff!'		=> \$chk_signoff,
+	'fixes-tag!'		=> \$chk_fixes_tag,
  	'patch!'		=> \$chk_patch,
  	'branch!'		=> \$chk_branch,
  	'emacs!'		=> \$emacs,
@@ -441,6 +444,10 @@ sub build_types {
  build_types();
 
  $chk_signoff = 0 if ($file);
+$chk_fixes_tag = 0 if ($file);
+
+my $gitroot = $ENV{'GIT_DIR'};
+$gitroot = ".git" if !defined($gitroot);
 
  my @rawlines = ();
  my @lines = ();
@@ -561,6 +568,28 @@ sub which {
  	return "";
  }
 
+sub git_commit_info {
+	my ($commit, $id, $desc) = @_;
+
+	return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
+
+	my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
+	$output =~ s/^\s*//gm;
+	my @lines = split("\n", $output);
+
+	return ($id, $desc) if ($#lines < 0);
+
+	if ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
+	    $lines[0] =~ /^fatal: bad object $commit/) {
+		$id = undef;
+	} else {
+		$id = substr($lines[0], 0, 12);
+		$desc = substr($lines[0], 41);
+	}
+
+	return ($id, $desc);
+}
+
  sub expand_tabs {
  	my ($str) = @_;
 
@@ -1811,6 +1840,47 @@ sub process {
  			}
  		}
 
+# Check Fixes: tag format and commit validity
+		if ($chk_fixes_tag &&
+		    $line =~ /^\s*(fixes:?)\s*(?:commit\s*)?([0-9a-f]{5,40})\s*(.*)?/i) {
+			my $tag = $1;
+			my $orig_commit = $2;
+			my $title = $3;
+
+			if ($line !~ /^\s*Fixes:\s+CVE/i) {
+				my $tag_case = not ($tag eq "Fixes:");
+				my $tag_space = not ($line =~ /^fixes:? [0-9a-f]{5,40}/i);
+				my $id_length = not ($orig_commit =~ /^[0-9a-f]{12,40}$/);
+				my $id_case = not ($orig_commit !~ /[A-F]/);
+
+				my $id = "0123456789ab";
+				my $description = "commit title";
+				my $has_quotes = 0;
+
+				if (defined $title && $title =~ /^\("(.*?)"\)$/) {
+					$description = $1 if ($1);
+					$has_quotes = 1;
+				} elsif (defined $title && $title =~ /^\(?(.*?)\)?$/) {
+					$description = $1 if ($1);
+				}
+
+				my ($cid, $ctitle) = git_commit_info($orig_commit, $id, $description);
+
+				if (defined($cid) && ($ctitle ne $description || $tag_case || $tag_space || $id_length || $id_case || !$has_quotes)) {
+					my $fixed = "Fixes: $cid (\"$ctitle\")";
+					WARN("Please use correct Fixes: style 'Fixes: <12+ chars of sha1> (\"<title line>\")'" .
+						" - ie: '$fixed'\n" . $herecurr);
+				}
+				if (which("git") ne "" && -e "$gitroot") {
+					my $hash = defined($cid) ? $cid : $orig_commit;
+					`git merge-base --is-ancestor $hash master 2>/dev/null`;

scripts/checkpatch.pl sub process { · line 1886

Quoted 10 lines
scripts/checkpatch.pl +7 -0
+					if ($? != 0) {
+						WARN("Fixes: commit $hash is not an ancestor of master\n" . $herecurr);
+					}
+				}
+			}
+		}
+
  # Check SPDX-License-Identifier references a permitted license
  		if (($rawline =~ m,SPDX-License-Identifier: (.*?)(\*/)?\s*$,) &&
  			$rawline !~ /^-/) {

Here is a test patch.

C.

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Test User <[email protected]>
Date: Wed, 23 Jul 2026 12:00:00 +0200
Subject: [PATCH] test: exercise Fixes: tag validation

This is a test commit to exercise checkpatch Fixes: tag validation.

Fixes 36227628d824 ("vfio-user: implement message send infrastructure")
Fixes 1a0c32a9da ("vfio-user: add coalesced posted writes")
Fixes 36227628d824 (vfio-user: implement message send infrastructure)
Fixes 36227628d824 ("vfio-user: implement message send infrastructure")
Fixes 36227628d824 ("vfio-user: implement message send infrastructure")
Fixes 36227628D824 ("vfio-user: implement message send infrastructure")
Fixes dcf1b77e834d ("hw/vfio/region: Create dmabuf for PCI BAR per region")
Fixes deadbeef1234 ("nonexistent commit")
Fixes CVE-2026-16288
---
 hw/vfio/pci.c | 1 +
 1 file changed, 1 insertion(+)
hw/vfio/pci.c +1 -0
index 1234567..abcdefg 100644
@@ -1,3 +1,4 @@
+/* test */
 
 
 
#2 lore raw
In reply to Cédric Le Goater
Quoted 11 lines · Cédric Le Goater

Adapt the kernel's checkpatch Fixes: tag validation for QEMU.

Add a git_commit_info() helper to resolve commit hashes and validate the Fixes: tag in commit messages. The canonical form is:

   Fixes: <12+ chars of sha1> ("<title line>")

The check validates capitalization, spacing, hash length, lowercase hex, and quoted title. When the format is wrong and the commit can be resolved, suggest the corrected Fixes: line.

Quoted 5 lines

When running inside a git repository, also verify that the referenced commit is an ancestor of master.

Lines matching "Fixes: CVE-*" are skipped. The check can be disabled with --no-fixes-tag.

Thank you for introducing this!

A comment below.

scripts/checkpatch.pl sub which { · line 583

Quoted 13 lines
scripts/checkpatch.pl +13 -0
+sub git_commit_info {
+	my ($commit, $id, $desc) = @_;
+
+	return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
+
+	my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
+	$output =~ s/^\s*//gm;
+	my @lines = split("\n", $output);
+
+	return ($id, $desc) if ($#lines < 0);
+
+	if ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
+	    $lines[0] =~ /^fatal: bad object $commit/) {

This is the first place in this script which depends on the C/EN locale being in effect. With different locales, git will produce different messages here.

Instead of relying on the exact wording, I think it's okay to check for the exit status of git command, and only assume we found the reference if git command finished successfully.

An alternative would be to export LC_ALL=C, but I think relying on the git exit code is more reliable.

Thanks,

/mjt

Quoted 9 lines
scripts/checkpatch.pl +9 -0
+		$id = undef;
+	} else {
+		$id = substr($lines[0], 0, 12);
+		$desc = substr($lines[0], 41);
+	}
+
+	return ($id, $desc);
+}
+
#3 lore raw
Quoted 31 lines · Michael Tokarev
Quoted 11 lines · Cédric Le Goater

Adapt the kernel's checkpatch Fixes: tag validation for QEMU.

Add a git_commit_info() helper to resolve commit hashes and validate the Fixes: tag in commit messages. The canonical form is:

Fixes <12+ chars of sha1> ("<title line>")

The check validates capitalization, spacing, hash length, lowercase hex, and quoted title. When the format is wrong and the commit can be resolved, suggest the corrected Fixes: line.

Quoted 5 lines

When running inside a git repository, also verify that the referenced commit is an ancestor of master.

Lines matching "Fixes: CVE-*" are skipped. The check can be disabled with --no-fixes-tag.

Thank you for introducing this!

A comment below.

Quoted 9 lines
scripts/checkpatch.pl +9 -0
+sub git_commit_info {
+    my ($commit, $id, $desc) = @_;
+
+    return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
+
+    my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
+    $output =~ s/^\s*//gm;
+    my @lines = split("\n", $output);
+
Quoted 8 lines
Quoted 4 lines

+    return ($id, $desc) if ($#lines < 0);
+
+    if ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ || +        $lines[0] =~ /^fatal: bad object $commit/) {

This is the first place in this script which depends on the C/EN locale being in effect.  With different locales, git will produce different messages here.

Linux uses:

  my $git_command ='export LANGUAGE=en_US.UTF-8; git';

Something this patch could do too.

Quoted 6 lines

Instead of relying on the exact wording, I think it's okay to check for the exit status of git command, and only assume we found the reference if git command finished successfully.

An alternative would be to export LC_ALL=C, but I think relying on the git exit code is more reliable.

I'd rather minimize the differences from the Linux version.

I will add a $git_command in v2 and use it in the git_commit_info() helper.

Thanks,

C.

#4 lore raw
Quoted 3 lines · Cédric Le Goater

Linux uses:

   my $git_command ='export LANGUAGE=en_US.UTF-8; git';

Does that work if your system doesn't have that locale configured?

-- PMM

#5 lore raw
Quoted 6 lines · Peter Maydell
Quoted 3 lines · Cédric Le Goater

Linux uses:

    my $git_command ='export LANGUAGE=en_US.UTF-8; git';

Does that work if your system doesn't have that locale configured?

Yeah, I had the same question. This is one more reason I think messing up with locale might not be a good idea. Maybe C.UTF-8 would be better, b/c it is often built-in (but not always).

Also, LANGUAGE vs LC_ALL.

I dunno why linux kernel folks choose this.

And I already explained in my previous email that it feels better to use exit status here than to parse command output. Again, I dunno why kernel folks choose this.

/mjt

Quoted 1 line

-- PMM

#6 lore raw
Quoted 12 lines · Michael Tokarev
Quoted 6 lines · Peter Maydell
Quoted 3 lines · Cédric Le Goater

Linux uses:

    my $git_command ='export LANGUAGE=en_US.UTF-8; git';

Does that work if your system doesn't have that locale configured?

Yeah, I had the same question.  This is one more reason I think messing up with locale might not be a good idea.  Maybe C.UTF-8 would be better, b/c it is often built-in (but not always).

Quoted 7 lines

Also, LANGUAGE vs LC_ALL.

I dunno why linux kernel folks choose this.

And I already explained in my previous email that it feels better to use exit status here than to parse command output.  Again, I dunno why kernel folks choose this.

So both of you would prefer:

+sub git_commit_info {
+ my ($commit, $id, $desc) = @_;
+
+ return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
+
+ my $output = git log --no-color --format='%H %s' -1 $commit 2>/dev/null;
+ if ($? != 0) {
+ $id = undef;
+ } else {
+ $output =~ s/^\s*//gm;
+ $id = substr($output, 0, 12);
+ $desc = substr($output, 41);
+ }
+
+ return ($id, $desc);
+}

It's fine with me. v3 ?

Thanks,

C.