|author||Jacob Keller <firstname.lastname@example.org>||2014-06-06 14:36:39 -0700|
|committer||Greg Kroah-Hartman <email@example.com>||2014-07-06 18:54:15 -0700|
Documentation/SubmittingPatches: describe the Fixes: tag
commit 8401aa1f59975c03eeebd3ac6d264cbdfe9af5de upstream. Update the SubmittingPatches process to include howto about the new 'Fixes:' tag to be used when a patch fixes an issue in a previous commit (found by git-bisect for example). Signed-off-by: Jacob Keller <firstname.lastname@example.org> Tested-by: Aaron Brown <email@example.com> Signed-off-by: Jeff Kirsher <firstname.lastname@example.org> Cc: Randy Dunlap <email@example.com> Signed-off-by: Andrew Morton <firstname.lastname@example.org> Signed-off-by: Linus Torvalds <email@example.com> Signed-off-by: Greg Kroah-Hartman <firstname.lastname@example.org>
Diffstat (limited to 'Documentation')
1 files changed, 21 insertions, 1 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 6e97e73d87b5..4dbba7e100a1 100644
@@ -131,6 +131,20 @@ If you cannot condense your patch set into a smaller set of patches,
then only post say 15 or so at a time and wait for review and integration.
+If your patch fixes a bug in a specific commit, e.g. you found an issue using
+git-bisect, please use the 'Fixes:' tag with the first 12 characters of the
+SHA-1 ID, and the one line summary.
+ Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()")
+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
+ abbrev = 12
+ fixes = Fixes: %h (\"%s\")
4) Style check your changes.
@@ -420,7 +434,7 @@ person it names. This tag documents that potentially interested parties
have been included in the discussion
-14) Using Reported-by:, Tested-by:, Reviewed-by: and Suggested-by:
+14) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:
If this patch fixes a problem reported by somebody else, consider adding a
Reported-by: tag to credit the reporter for their contribution. Please
@@ -475,6 +489,12 @@ idea was not posted in a public forum. That said, if we diligently credit our
idea reporters, they will, hopefully, be inspired to help us again in the
+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
+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 #2 above for more details.
15) The canonical patch format