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>
Heiko Voigt committed
Jul 28, 2016 at 14:55 UTC
175d38ca231d0dd9cca3bbebae40f797346a850d
1 file changed
+5
Documentation/SubmittingPatches
+5
@@ -121,6 +121,11 @@ its behaviour. Try to make sure your explanation can be understood
121
without external resources. Instead of giving a URL to a mailing list
122
archive, summarize the relevant points of the discussion.
123
124
+If you want to reference a previous commit in the history of a stable
125
+branch use the format "abbreviated sha1 (subject, date)". So for example
126
+like this: "Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
127
+noticed [...]".
128
+
129
130
(3) Generate your patch using Git tools out of your commits.
131