From: Junio C Hamano <junkio@cox.net>
Date: Wed, 17 Jan 2007 06:53:28 +0000 (-0800)
Subject: git-commit: document log message formatting convention
X-Git-Tag: v1.5.0-rc2~65
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=936f32d3de468db8daf853155ddd5c6b191af60c;p=git

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 6139386ad7..9c84353068 100644
--- 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