diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2016-09-08 21:36:03 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2016-09-08 21:36:03 -0700 |
| commit | 3e8e69a695746facc1fca6f761b4c5bf97761a49 (patch) | |
| tree | bac4549abfa54accec7774572adc0f458822764f | |
| parent | Merge branch 'sg/reflog-past-root' into maint (diff) | |
| parent | SubmittingPatches: use gitk's "Copy commit summary" format (diff) | |
| download | tgif-3e8e69a695746facc1fca6f761b4c5bf97761a49.tar.xz | |
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
| -rw-r--r-- | Documentation/SubmittingPatches | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index e8ad978824..08352deaae 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -121,6 +121,16 @@ its behaviour. Try to make sure your explanation can be understood 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)", +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. |