summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2016-09-09 04:36:03 (GMT)
committerJunio C Hamano <gitster@pobox.com>2016-09-09 04:36:03 (GMT)
commit3e8e69a695746facc1fca6f761b4c5bf97761a49 (patch)
treebac4549abfa54accec7774572adc0f458822764f /Documentation
parentb5abd302ef0e3e371a4a7fb3c5d1e0415a1fa5ed (diff)
parent4369523b4b1ec34c48b11cc18a655ba445a231ac (diff)
downloadgit-3e8e69a695746facc1fca6f761b4c5bf97761a49.zip
git-3e8e69a695746facc1fca6f761b4c5bf97761a49.tar.gz
git-3e8e69a695746facc1fca6f761b4c5bf97761a49.tar.bz2
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
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/SubmittingPatches10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index e8ad978..08352de 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.