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>

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 · Jiri Kosina
1 parent ed7afeae24
Showing 1 changed file with 10 additions and 0 deletions Side-by-side Diff
Documentation/SubmittingPatches
@@ -109,6 +109,16 @@
 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.
...	...	@@ -109,6 +109,16 @@
109	109	If the patch fixes a logged bug entry, refer to that bug entry by
110	110	number and URL.
111	111
	112	+If you want to refer to a specific commit, don't just refer to the
	113	+SHA-1 ID of the commit. Please also include the oneline summary of
	114	+the commit, to make it easier for reviewers to know what it is about.
	115	+Example:
	116	+
	117	+ Commit e21d2170f36602ae2708 ("video: remove unnecessary
	118	+ platform_set_drvdata()") removed the unnecessary
	119	+ platform_set_drvdata(), but left the variable "dev" unused,
	120	+ delete it.
	121	+
112	122
113	123	3) Separate your changes.
114	124