aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/SubmittingPatches
diff options
context:
space:
mode:
authorGeert Uytterhoeven <geert@linux-m68k.org>2013-07-31 21:59:38 (GMT)
committerJiri Kosina <jkosina@suse.cz>2013-08-20 10:58:15 (GMT)
commit0af5270324cc584629c197d9bfdf2c4ab3d81bd7 (patch)
tree4a0d8a119ce69385d4d1774637ad6afea2f9584d /Documentation/SubmittingPatches
parented7afeae24f9a3a52c677d776162f171e1ee9e12 (diff)
downloadkernel_replicant_linux-0af5270324cc584629c197d9bfdf2c4ab3d81bd7.zip
kernel_replicant_linux-0af5270324cc584629c197d9bfdf2c4ab3d81bd7.tar.gz
kernel_replicant_linux-0af5270324cc584629c197d9bfdf2c4ab3d81bd7.tar.bz2
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>
Diffstat (limited to 'Documentation/SubmittingPatches')
-rw-r--r--Documentation/SubmittingPatches10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 6e97e73..26b1e31d 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.