Browse Source

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>
maint
Junio C Hamano 18 years ago
parent
commit
936f32d3de
  1. 6
      Documentation/git-commit.txt

6
Documentation/git-commit.txt

@ -218,6 +218,12 @@ refuses to run when given pathnames (but see `-i` option). @@ -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

Loading…
Cancel
Save