mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-06-02 18:46:15 +02:00
Code

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
This commit is contained in:
Junio C Hamano 2016-09-08 21:36:03 -07:00
parent b5abd302ef 4369523b4b
commit 3e8e69a695
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/SubmittingPatches
View File

@ -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.