From: Geert Uytterhoeven Date: Wed, 31 Jul 2013 21:59:38 +0000 (-0700) Subject: Documentation/SubmittingPatches: Request summaries for commit references X-Git-Tag: accepted/tizen/common/20141203.182822~1561^2~21 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0af5270324cc584629c197d9bfdf2c4ab3d81bd7;p=platform%2Fkernel%2Flinux-arm64.git 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 --- diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 6e97e73..26b1e31 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.