diff options
| author | Junio C Hamano <junkio@cox.net> | 2007-01-16 22:53:28 -0800 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2007-01-16 22:53:28 -0800 |
| commit | 936f32d3de468db8daf853155ddd5c6b191af60c (patch) | |
| tree | 1f1b3917005313e12f31fca4d336d85ca9b73d03 /Documentation/git-commit.txt | |
| parent | 276bc2caab78a4493b35f8d582dd8eeff4866615 (diff) | |
| download | git-936f32d3de468db8daf853155ddd5c6b191af60c.tar.gz | |
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>
Diffstat (limited to 'Documentation/git-commit.txt')
| -rw-r--r-- | Documentation/git-commit.txt | 6 |
1 files changed, 6 insertions, 0 deletions
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 |