From: Josh Triplett Date: Thu, 3 Apr 2014 21:48:28 +0000 (-0700) Subject: SubmittingPatches: add style recommendation to use imperative descriptions X-Git-Tag: v5.15~18164^2~135 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=74a475acea49459721ae4b062d3da68c74259009;p=platform%2Fkernel%2Flinux-starfive.git SubmittingPatches: add style recommendation to use imperative descriptions Most commit messages use this style, and the recommendation frequently comes up in discussions (especially in response to patches that don't use it), but that recommendation doesn't actually appear anywhere in Documentation. Add this style guideline to SubmittingPatches, using the description from git's SubmittingPatches. Signed-off-by: Josh Triplett Acked-by: Borislav Petkov Cc: Rob Landley Cc: Randy Dunlap Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 26b1e31d..c74e73c 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -106,6 +106,11 @@ I.e., the patch (series) and its description should be self-contained. This benefits both the patch merger(s) and reviewers. Some reviewers probably didn't even receive earlier versions of the patch. +Describe your changes in imperative mood, e.g. "make xyzzy do frotz" +instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy +to do frotz", as if you are giving orders to the codebase to change +its behaviour. + If the patch fixes a logged bug entry, refer to that bug entry by number and URL.