git-commit: document log message formatting convention
authorJunio C Hamano <junkio@cox.net>
Wed, 17 Jan 2007 06:53:28 +0000 (22:53 -0800)
committerJunio C Hamano <junkio@cox.net>
Wed, 17 Jan 2007 06:53:28 +0000 (22:53 -0800)
Take it from the tutorial, since not everybody necessarily reads it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/git-commit.txt

index 6139386..9c84353 100644 (file)
@@ -218,6 +218,12 @@ refuses to run when given pathnames (but see `-i` option).
 DISCUSSION
 ----------
 
 DISCUSSION
 ----------
 
+Though not required, it's a good idea to begin the commit message
+with a single short (less than 50 character) line summarizing the
+change, followed by a blank line and then a more thorough description.
+Tools that turn commits into email, for example, use the first line
+on the Subject: line and the rest of the commit in the body.
+
 include::i18n.txt[]
 
 ENVIRONMENT VARIABLES
 include::i18n.txt[]
 
 ENVIRONMENT VARIABLES