diff options
| author |  Beat Bolli <dev+git@drbeat.li> | 2016-08-26 18:59:01 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2016-08-26 15:58:10 -0700 |
| commit | 4369523b4b1ec34c48b11cc18a655ba445a231ac (patch) | |
| tree | bf91f3f4f40db4e85defc2ce54bd4c345b3d658c /Documentation/SubmittingPatches | |
| parent | SubmittingPatches: document how to reference previous commits (diff) | |
| download | tgif-4369523b4b1ec34c48b11cc18a655ba445a231ac.tar.xz | |
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>
Diffstat (limited to 'Documentation/SubmittingPatches')
| -rw-r--r-- | Documentation/SubmittingPatches | 11 |
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. |