Skip to content

Commit 3e8e69a

Browse files
committed
Merge branch 'hv/doc-commit-reference-style' into maint
A small doc update. * hv/doc-commit-reference-style: SubmittingPatches: use gitk's "Copy commit summary" format SubmittingPatches: document how to reference previous commits
2 parents b5abd30 + 4369523 commit 3e8e69a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Documentation/SubmittingPatches

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,16 @@ its behaviour. Try to make sure your explanation can be understood
121121
without external resources. Instead of giving a URL to a mailing list
122122
archive, summarize the relevant points of the discussion.
123123

124+
If you want to reference a previous commit in the history of a stable
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+
124134

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

0 commit comments

Comments
 (0)