Browse Source

Documentation/SubmittingPatches: Request summaries for commit references

Request inclusion of oneline summaries when referring to other commits

Signed-off-by: Geert Uytterhoeven <geert@linux-m68k.org>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
Geert Uytterhoeven 12 years ago
parent
commit
0af5270324
1 changed files with 10 additions and 0 deletions
  1. 10 0
      Documentation/SubmittingPatches

+ 10 - 0
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.