summaryrefslogtreecommitdiff
path: root/Documentation/SubmittingPatches
diff options
context:
space:
mode:
authorLibravatar Heiko Voigt <hvoigt@hvoigt.net>2016-07-28 14:55:14 +0200
committerLibravatar Junio C Hamano <gitster@pobox.com>2016-08-17 10:47:33 -0700
commit175d38ca231d0dd9cca3bbebae40f797346a850d (patch)
treea5cdd5ef33dbd41722f1234fa32dc2fcdda7b382 /Documentation/SubmittingPatches
parentGit 2.8.4 (diff)
downloadtgif-175d38ca231d0dd9cca3bbebae40f797346a850d.tar.xz
SubmittingPatches: document how to reference previous commits
To reference previous commits people used to put just the abbreviated SHA-1 into commit messages. This is what has evolved as a more stable format for referencing commits. So lets document it for everyone to look-up when needed. Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/SubmittingPatches')
-rw-r--r--Documentation/SubmittingPatches5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index e8ad978824..500230c054 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -121,6 +121,11 @@ 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)". So for example
+like this: "Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
+noticed [...]".
+
(3) Generate your patch using Git tools out of your commits.