SubmittingPatches: use gitk's "Copy commit summary" format
Update the suggestion in 175d38ca ("SubmittingPatches: document how to reference previous commits", 2016-07-28) on the format to refer to a commit to match what gitk has been giving since last year with its "Copy commit summary" command; also mention this as one of the ways to obtain a commit reference in this format. Signed-off-by: Beat Bolli <dev+git@drbeat.li> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Beat Bolli committed
Aug 26, 2016 at 18:59 UTC
4369523b4b1ec34c48b11cc18a655ba445a231ac
1 file changed
+8
-3
Documentation/SubmittingPatches
+8
-3
@@ -122,9 +122,14 @@ without external resources. Instead of giving a URL to a mailing list
122
archive, summarize the relevant points of the discussion.
123
124
If you want to reference a previous commit in the history of a stable
125
-branch use the format "abbreviated sha1 (subject, date)". So for example
126
-like this: "Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
127
-noticed [...]".
125
+branch, use the format "abbreviated sha1 (subject, date)",
126
+with the subject enclosed in a pair of double-quotes, like this:
127
+
128
+ Commit f86a374 ("pack-bitmap.c: fix a memleak", 2015-03-30)
129
+ noticed that ...
130
+
131
+The "Copy commit summary" command of gitk can be used to obtain this
132
+format.
133
134
135
(3) Generate your patch using Git tools out of your commits.