| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <tencent_F8CFC8ED723F6E8103B4AF3D98D63D7F1F08@qq.com>
Date: Fri, 10 Jan 2025 12:20:09 +0000
From: Yeking@...54.com
To: kuba@...nel.org
Cc: 谢致邦 (XIE Zhibang) <Yeking@...54.com>,
Jonathan Corbet <corbet@....net>,
"Theodore Ts'o" <tytso@....edu>,
Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
Andy Whitcroft <apw@...onical.com>,
Joe Perches <joe@...ches.com>,
Dwaipayan Ray <dwaipayanray1@...il.com>,
Lukas Bulwahn <lukas.bulwahn@...il.com>,
Jacob Keller <jacob.e.keller@...el.com>,
Andrew Morton <akpm@...ux-foundation.org>,
workflows@...r.kernel.org,
linux-doc@...r.kernel.org,
linux-kernel@...r.kernel.org,
tech-board-discuss@...ts.linux.dev
Subject: [PATCH] Add short author date to Fixes tag
From: 谢致邦 (XIE Zhibang) <Yeking@...54.com>
The old Fixes tag style is at least 10 years old. It lacks date
information, which can lead to misjudgment. So I added short author date
to avoid this. This make it clear at a glance and reduce
misunderstandings.
For example:
Old Fixes tag style:
* Fixes: fd3040b9394c ("net: ethernet: Add driver for Sunplus SP7021")
* Fixes: a76053707dbf ("dev_ioctl: split out ndo_eth_ioctl")
This will make people mistakenly think that "a76053707dbf" broke
"fd3040b9394c".[1]
New Fixes tag style:
* Fixes: fd3040b9394c ("net: ethernet: Add driver for Sunplus SP7021", 2022-05-08)
* Fixes: a76053707dbf ("dev_ioctl: split out ndo_eth_ioctl", 2021-07-27)
This makes it clear that the newly introduced driver did not follow the
existing changes.
[1] https://lore.kernel.org/all/20250109180212.71e4e53c@kernel.org/
docs: submitting-patches: The short author date of old example
"54a4f0239f2e" is 2010-05-05, which is not immediately obvious as
YYYY-MM-DD, so change example.
Fixes: 8401aa1f5997 ("Documentation/SubmittingPatches: describe the Fixes: tag", 2014-06-06)
Signed-off-by: 谢致邦 (XIE Zhibang) <Yeking@...54.com>
---
Documentation/process/5.Posting.rst | 2 +-
Documentation/process/maintainer-tip.rst | 4 +--
.../process/researcher-guidelines.rst | 2 +-
Documentation/process/submitting-patches.rst | 8 ++---
scripts/checkpatch.pl | 30 +++++++++++--------
5 files changed, 25 insertions(+), 21 deletions(-)
diff --git a/Documentation/process/5.Posting.rst b/Documentation/process/5.Posting.rst
index b3eff03ea249..38c9c94e7448 100644
--- a/Documentation/process/5.Posting.rst
+++ b/Documentation/process/5.Posting.rst
@@ -199,7 +199,7 @@ document; what follows here is a brief summary.
One tag is used to refer to earlier commits which introduced problems fixed by
the patch::
- Fixes: 1f2e3d4c5b6a ("The first line of the commit specified by the first 12 characters of its SHA-1 ID")
+ Fixes: 1f2e3d4c5b6a ("The first line of the commit specified by the first 12 characters of its SHA-1 ID", 2024-12-31)
Another tag is used for linking web pages with additional backgrounds or
details, for example an earlier discussion which leads to the patch or a
diff --git a/Documentation/process/maintainer-tip.rst b/Documentation/process/maintainer-tip.rst
index e374b67b3277..fb97a6853e42 100644
--- a/Documentation/process/maintainer-tip.rst
+++ b/Documentation/process/maintainer-tip.rst
@@ -270,7 +270,7 @@ Ordering of commit tags
To have a uniform view of the commit tags, the tip maintainers use the
following tag ordering scheme:
- - Fixes: 12char-SHA1 ("sub/sys: Original subject line")
+ - Fixes: 12char-SHA1 ("sub/sys: Original subject line", YYYY-MM-DD)
A Fixes tag should be added even for changes which do not need to be
backported to stable kernels, i.e. when addressing a recently introduced
@@ -295,7 +295,7 @@ following tag ordering scheme:
The recent replacement of foo with bar left an unused instance of
variable foo around. Remove it.
- Fixes: abcdef012345678 ("x86/xxx: Replace foo with bar")
+ Fixes: abcdef012345678 ("x86/xxx: Replace foo with bar", 2024-12-31)
Signed-off-by: J.Dev <j.dev@...l>
The latter puts the information about the patch into the focus and
diff --git a/Documentation/process/researcher-guidelines.rst b/Documentation/process/researcher-guidelines.rst
index beb484c5965d..472ca0a4684d 100644
--- a/Documentation/process/researcher-guidelines.rst
+++ b/Documentation/process/researcher-guidelines.rst
@@ -149,7 +149,7 @@ For example::
[1] https://url/to/leakmagic/details
Reported-by: Researcher <researcher@...il>
- Fixes: aaaabbbbccccdddd ("Introduce support for FooBar")
+ Fixes: aaaabbbbccccdddd ("Introduce support for FooBar", 2024-12-31)
Signed-off-by: Author <author@...il>
Reviewed-by: Reviewer <reviewer@...il>
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 1518bd57adab..4df1e722130b 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -148,7 +148,7 @@ the SHA-1 ID, and the one line summary. Do not split the tag across multiple
lines, tags are exempt from the "wrap at 75 columns" rule in order to simplify
parsing scripts. For example::
- Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
+ Fixes: 6a451e2c5c03 ("ALSA: hda/tas2781: Ignore SUBSYS_ID not found for tas2563 projects", 2024-12-30)
The following ``git config`` settings can be used to add a pretty format for
outputting the above style in the ``git log`` or ``git show`` commands::
@@ -156,12 +156,12 @@ outputting the above style in the ``git log`` or ``git show`` commands::
[core]
abbrev = 12
[pretty]
- fixes = Fixes: %h (\"%s\")
+ fixes = Fixes: %h (\"%s\", %as)
An example call::
- $ git log -1 --pretty=fixes 54a4f0239f2e
- Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
+ $ git log -1 --pretty=fixes 6a451e2c5c03
+ Fixes: 6a451e2c5c03 ("ALSA: hda/tas2781: Ignore SUBSYS_ID not found for tas2563 projects", 2024-12-30)
.. _split_changes:
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 9eed3683ad76..580d5620ec7d 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -1228,15 +1228,15 @@ sub git_is_single_file {
}
sub git_commit_info {
- my ($commit, $id, $desc) = @_;
+ my ($commit, $id, $desc, $date) = @_;
- return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
+ return ($id, $desc, $date) if ((which("git") eq "") || !(-e "$gitroot"));
- my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
+ my $output = `${git_command} log --no-color --format='%H %s %as' -1 $commit 2>&1`;
$output =~ s/^\s*//gm;
my @lines = split("\n", $output);
- return ($id, $desc) if ($#lines < 0);
+ return ($id, $desc, $date) if ($#lines < 0);
if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
# Maybe one day convert this block of bash into something that returns
@@ -1253,10 +1253,11 @@ sub git_commit_info {
$id = undef;
} else {
$id = substr($lines[0], 0, 12);
- $desc = substr($lines[0], 41);
+ $desc = substr($lines[0], 41, -11);
+ $date = substr($lines[0], -10);
}
- return ($id, $desc);
+ return ($id, $desc, $date);
}
$chk_signoff = 0 if ($file);
@@ -3214,16 +3215,19 @@ sub process {
my $orig_commit = $2;
my $title;
my $title_has_quotes = 0;
+ my $date;
$fixes_tag = 1;
if (defined $3) {
+ $date = substr($3, -11, 10);
# Always strip leading/trailing parens then double quotes if existing
- $title = substr($3, 1, -1);
+ $title = substr($3, 1, -13);
if ($title =~ /^".*"$/) {
$title = substr($title, 1, -1);
$title_has_quotes = 1;
}
} else {
- $title = "commit title"
+ $title = "commit title";
+ $date = "YYYY-MM-DD";
}
@@ -3234,15 +3238,15 @@ sub process {
my $id_case = not ($orig_commit !~ /[A-F]/);
my $id = "0123456789ab";
- my ($cid, $ctitle) = git_commit_info($orig_commit, $id,
- $title);
+ my ($cid, $ctitle, $cdate) = git_commit_info($orig_commit, $id,
+ $title, $date);
- if ($ctitle ne $title || $tag_case || $tag_space ||
+ if ($ctitle ne $title || $cdate ne $date || $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) &&
+ "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\", YYYY-MM-DD)' - ie: 'Fixes: $cid (\"$ctitle\", $cdate)'\n" . $herecurr) &&
$fix) {
- $fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\")";
+ $fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\", $cdate)";
}
}
}
--
2.43.0
Powered by blists - more mailing lists