aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-shortlog.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-shortlog.txt
parente70d1632bdaf25a9ee528e78133cab319083eade (diff)
downloadgit-52ffe995b9a3fc43de8eca80bedab2e055aac562.tar.gz
git-52ffe995b9a3fc43de8eca80bedab2e055aac562.tar.xz
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-shortlog.txt')
-rw-r--r--Documentation/git-shortlog.txt3
1 files changed, 1 insertions, 2 deletions
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index 01d841731..afeb4cdf1 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -14,8 +14,7 @@ git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
DESCRIPTION
-----------
Summarizes 'git log' output in a format suitable for inclusion
-in release announcements. Each commit will be grouped by author and
-the first line of the commit message will be shown.
+in release announcements. Each commit will be grouped by author and title.
Additionally, "[PATCH]" will be stripped from the commit description.