doc: update SubmittingPatches about the Fixed tag
PATCH 1/1 doc: update SubmittingPatches about the Fixed tag
From: Jacob Keller <[email protected]>
This patch updates the SubmittingPatches process to include howto about the new 'Fixed' tag to be used when a patch fixes an issue in a previous commit (found by git-bisect for example).
--- Documentation/SubmittingPatches | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-)
Documentation/SubmittingPatches +13 -1
@@ -119,6 +119,13 @@ Example: platform_set_drvdata(), but left the variable "dev" unused, delete it. +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. +Example: + + Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()") + 3) Separate your changes.
@@ -430,7 +437,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
@@ -485,6 +492,11 @@ 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 future. +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 is the preferred method for indicating a bug fixed by +the patch. See #2 above for more details. + 15) The canonical patch format
Signature · 1 line
1.8.5.GIT
Quoted 18 lines · Aaron Brown
From: Jacob Keller <[email protected]>
This patch updates the SubmittingPatches process to include howto about the new 'Fixed' 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 <[email protected]>Tested-by Aaron Brown <[email protected]>Signed-off-by Aaron Brown <[email protected]>--- Documentation/SubmittingPatches | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-)Documentation/SubmittingPatches +0
-0
Documentation/SubmittingPatches Example: · line 124
Quoted 6 lines
Documentation/SubmittingPatches +3
-0@@ -119,6 +119,13 @@ Example: platform_set_drvdata(), but left the variable "dev" unused, delete it. +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.
It may be worth mentioning here that this can be configured in your git config by setting core.abbrev = 12.
Quoted 17 lines
Documentation/SubmittingPatches +5
-1+Example: + + Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()") + 3) Separate your changes.@@ -430,7 +437,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
Documentation/SubmittingPatches idea was not posted in a public forum. That said, if we diligently credit our · line 499
Quoted 8 lines
Documentation/SubmittingPatches +5
-0@@ -485,6 +492,11 @@ 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 future. +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 is the preferred method for indicating a bug fixed by +the patch. See #2 above for more details. +
imho, the most useful aspect of this tag is for determining which stable kernel versions the fix should be backported to. Perhaps
"...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..."
thx,
Jason.