about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2016-09-08 21:49:51 -0700
committerJunio C Hamano <gitster@pobox.com>2016-09-08 21:49:51 -0700
commitd012326d489e29777ac457c3017d8b46f6546d24 (patch)
treeaf887ed30f6e6055a1f3fa39edf7220f16b2e752
parent02c6c14d6c304f094b680f583a1dd6e4fe75736c (diff)
parent4369523b4b1ec34c48b11cc18a655ba445a231ac (diff)
downloadgit-svn-d012326d489e29777ac457c3017d8b46f6546d24.tar.gz
A small doc update.

* hv/doc-commit-reference-style:
  SubmittingPatches: use gitk's "Copy commit summary" format
-rw-r--r--Documentation/SubmittingPatches11
1 files changed, 8 insertions, 3 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 500230c054..08352deaae 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -122,9 +122,14 @@ without external resources. Instead of giving a URL to a mailing list
 archive, summarize the relevant points of the discussion.
 
 If you want to reference a previous commit in the history of a stable
-branch use the format "abbreviated sha1 (subject, date)". So for example
-like this: "Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
-noticed [...]".
+branch, use the format "abbreviated sha1 (subject, date)",
+with the subject enclosed in a pair of double-quotes, like this:
+
+    Commit f86a374 ("pack-bitmap.c: fix a memleak", 2015-03-30)
+    noticed that ...
+
+The "Copy commit summary" command of gitk can be used to obtain this
+format.
 
 
 (3) Generate your patch using Git tools out of your commits.