Skip to content

Commit 4369523

Browse files
bbolligitster
authored andcommitted
SubmittingPatches: use gitk's "Copy commit summary" format
Update the suggestion in 175d38c ("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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 175d38c commit 4369523

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

Documentation/SubmittingPatches

+8-3
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,14 @@ without external resources. Instead of giving a URL to a mailing list
122122
archive, summarize the relevant points of the discussion.
123123

124124
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.
128133

129134

130135
(3) Generate your patch using Git tools out of your commits.

0 commit comments

Comments
 (0)