aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-commit.txt
diff options
context:
space:
mode:
authorJeremy White <jwhite@codeweavers.com>2012-09-13 17:27:09 -0500
committerJunio C Hamano <gitster@pobox.com>2012-09-13 21:30:21 -0700
commit52ffe995b9a3fc43de8eca80bedab2e055aac562 (patch)
tree0d0fbb4b3a2b1b052ad199317e6adff81cb83aee /Documentation/git-commit.txt
parente70d1632bdaf25a9ee528e78133cab319083eade (diff)
downloadgit-52ffe995b9a3fc43de8eca80bedab2e055aac562.tar.gz
Documentation: describe subject more precisely
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>
Diffstat (limited to 'Documentation/git-commit.txt')
-rw-r--r--Documentation/git-commit.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 4622297ec9..9594ac8e9d 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -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[]