mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: describe subject more precisely

Browse Source 
The discussion of email subject throughout the documentation is
misleading; it indicates that the first line will always become
the subject.  In fact, the subject is generally all lines up until
the first full blank line.

This patch refines that, and makes more use of the concept of a
commit title, with the title being all text up to the first blank line.

Signed-off-by: Jeremy White <jwhite@codeweavers.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jeremy White
2012-09-13 17:27:09 -05:00
committed by Junio C Hamano
parent e70d1632bd
commit 52ffe995b9
7 changed files with 31 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/git-commit.txt
View File

@ -389,8 +389,10 @@ 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.
The text up to the first blank line in a commit message is treated
as the commit title, and that title is used throughout git.
For example, linkgit:git-format-patch[1] turns a commit into email, and it uses
the title on the Subject line and the rest of the commit in the body.
include::i18n.txt[]