development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-25 02:35:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

SubmittingPatches: use gitk's "Copy commit summary" format

Browse source 
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>
This commit is contained in:
Beat Bolli 2016-08-26 18:59:01 +02:00 committed by Junio C Hamano
parent 175d38ca23
commit 4369523b4b
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
Documentation/SubmittingPatches
View file

@ -122,9 +122,14 @@ without external resources. Instead of giving a URL to a mailing list
archive, summarize the relevant points of the discussion. archive, summarize the relevant points of the discussion.
If you want to reference a previous commit in the history of a stable 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 branch, use the format "abbreviated sha1 (subject, date)",
like this: "Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30) with the subject enclosed in a pair of double-quotes, like this:
noticed [...]".
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. (3) Generate your patch using Git tools out of your commits.