From 0af5270324cc584629c197d9bfdf2c4ab3d81bd7 Mon Sep 17 00:00:00 2001 From: Geert Uytterhoeven Date: Wed, 31 Jul 2013 14:59:38 -0700 Subject: Documentation/SubmittingPatches: Request summaries for commit references Request inclusion of oneline summaries when referring to other commits Signed-off-by: Geert Uytterhoeven Signed-off-by: Jiri Kosina --- Documentation/SubmittingPatches | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'Documentation/SubmittingPatches') diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 6e97e73d87b5..26b1e31d5a13 100644 --- 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. -- cgit v1.2.3