git-commit: document log message formatting convention
Take it from the tutorial, since not everybody necessarily reads it. Signed-off-by: Junio C Hamano <junkio@cox.net>
Junio C Hamano committed
Jan 16, 2007 at 22:53 UTC
936f32d3de468db8daf853155ddd5c6b191af60c
1 file changed
+6
Documentation/git-commit.txt
+6
@@ -218,6 +218,12 @@ refuses to run when given pathnames (but see `-i` option).
218
DISCUSSION
219
----------
220
221
+Though not required, it's a good idea to begin the commit message
222
+with a single short (less than 50 character) line summarizing the
223
+change, followed by a blank line and then a more thorough description.
224
+Tools that turn commits into email, for example, use the first line
225
+on the Subject: line and the rest of the commit in the body.
226
+
227
include::i18n.txt[]
228
229
ENVIRONMENT VARIABLES