Documentation/SubmittingPatches: Request summaries for commit references

Request inclusion of oneline summaries when referring to other commits Signed-off-by: Geert Uytterhoeven <[email protected]> Signed-off-by: Jiri Kosina <[email protected]>
akiyks · Aug 20, 2013 · 0af5270 · 0af5270
1 parent ed7afea
commit 0af5270
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
@@ -109,6 +109,16 @@ probably didn't even receive earlier versions of the patch.
 If the patch fixes a logged bug entry, refer to that bug entry by
 number and URL.
 
+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.
+
 
 3) Separate your changes.