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>

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 6139386ad70bbac6603c69f6d69a8ab9b5d477fc..9c8435306845cd417ce014d24240a52e8110e42d 100644 (file)
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -218,6 +218,12 @@ refuses to run when given pathnames (but see `-i` option).
 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