]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
docs: submitting-patches: adjust Fixes definition slightly
authorJakub Kicinski <kuba@kernel.org>
Thu, 4 Sep 2025 14:45:33 +0000 (07:45 -0700)
committerJonathan Corbet <corbet@lwn.net>
Tue, 9 Sep 2025 19:42:37 +0000 (13:42 -0600)
Every now and then people send stylistic patches and use Fixes
purely to refer to a commit which added the ugly or unnecessary
code. Reword the docs about Fixes.

It should hopefully be enough to lead with the word "bug"
rather than "issue". We can add more verbiage later, tho, let's
try the word swap first. I always feel like the more words the
smaller the chance someone will actually read the docs.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20250904144533.2146576-1-kuba@kernel.org>

Documentation/process/submitting-patches.rst

index cede4e7b29af46d23e6f2177f1d6107c1e15b108..5778cb9701e14bf5b19bb862f4306eb73fb79772 100644 (file)
@@ -602,8 +602,8 @@ future. Note, this is one of only three tags you might be able to use without
 explicit permission of the person named (see 'Tagging people requires
 permission' below for details).
 
-A Fixes: tag indicates that the patch fixes an issue in a previous commit. It
-is used to make it easy to determine where a bug originated, which can help
+A Fixes: tag indicates that the patch fixes a bug in a previous commit. It
+is used to make it easy to determine where an issue originated, which can help
 review a bug fix. This tag also assists the stable kernel team in determining
 which stable kernel versions should receive your fix. This is the preferred
 method for indicating a bug fixed by the patch. See :ref:`describe_changes`