Clarify the convention for commit references in changelogs so it matches
what checkpatch suggests; see d311cd44545f ("checkpatch: add test for
commit id formatting style in commit log").
I chose a different example to make the ("") around the description more
obvious.
Signed-off-by: Bjorn Helgaas <bhelgaas@xxxxxxxxxx>
---
Documentation/SubmittingPatches | 33 ++++++++++++---------------------
1 file changed, 12 insertions(+), 21 deletions(-)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index b03a832..e1063b8 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -168,27 +168,18 @@ resources. In addition to giving a URL to a mailing list archive or
bug, summarize the relevant points of the discussion that led to the
patch as submitted.
-If you want to refer to a specific commit, don't just refer to the
-SHA-1 ID of the commit. Please also include the oneline summary of
-the commit, to make it easier for reviewers to know what it is about.
-Example:
-
- Commit e21d2170f36602ae2708 ("video: remove unnecessary
- platform_set_drvdata()") removed the unnecessary
- platform_set_drvdata(), but left the variable "dev" unused,
- delete it.
-
-You should also be sure to use at least the first twelve characters of the
-SHA-1 ID. The kernel repository holds a *lot* of objects, making
-collisions with shorter IDs a real possibility. Bear in mind that, even if
-there is no collision with your six-character ID now, that condition may
-change five years from now.
-
-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. For example:
-
- Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()")
+When referring to a specific commit, please include both the first 12
+characters of the SHA-1 ID and the one-line summary to make it easier for
+reviewers to know what it is about. For example:
+
+ Commit 523c5b89640e ("i2c: Remove support for legacy PM") removed
+ the PM ops from the bus type ...
+
+If your patch fixes a bug in a specific commit, e.g., you found an issue
+using git-bisect, please use the 'Fixes:' tag, again with the first 12
+characters of the SHA-1 ID and the one-line summary. For example:
+
+ Fixes: 523c5b89640e ("i2c: Remove support for legacy PM")
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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
