diff options
author | Jeremy White <jwhite@codeweavers.com> | 2012-09-13 17:27:09 -0500 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2012-09-13 21:30:21 -0700 |
commit | 52ffe995b9a3fc43de8eca80bedab2e055aac562 (patch) | |
tree | 0d0fbb4b3a2b1b052ad199317e6adff81cb83aee /Documentation/user-manual.txt | |
parent | e70d1632bdaf25a9ee528e78133cab319083eade (diff) | |
download | git-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/user-manual.txt')
-rw-r--r-- | Documentation/user-manual.txt | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 03d95dc290..85651b57ae 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1136,9 +1136,12 @@ Creating good commit messages 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. +description. 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. + [[ignoring-files]] Ignoring files |