aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-shortlog.txt
diff options
context:
space:
mode:
authorJonas Fonseca <fonseca@diku.dk>2006-06-07 20:32:33 +0200
committerJunio C Hamano <junkio@cox.net>2006-06-07 12:37:46 -0700
commit74237d6236d7e32f69469ff26df3f3bb3875f523 (patch)
treede5abe163180aa34f16406197ff8be5f26a068ba /Documentation/git-shortlog.txt
parent34925d35ff278c7377e0cf3fce0227d5eceffeb5 (diff)
downloadgit-74237d6236d7e32f69469ff26df3f3bb3875f523.tar.gz
git-74237d6236d7e32f69469ff26df3f3bb3875f523.tar.xz
Misc doc improvements
Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-shortlog.txt')
-rw-r--r--Documentation/git-shortlog.txt19
1 files changed, 16 insertions, 3 deletions
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index 54fb922ba..7486ebe78 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -5,7 +5,6 @@ NAME
----
git-shortlog - Summarize 'git log' output
-
SYNOPSIS
--------
git-log --pretty=short | 'git-shortlog'
@@ -13,8 +12,22 @@ git-log --pretty=short | 'git-shortlog'
DESCRIPTION
-----------
Summarizes 'git log' output in a format suitable for inclusion
-in release announcements.
-
+in release announcements. Each commit will be grouped by author
+the first line of the commit message will be shown.
+
+Additionally, "[PATCH]" will be stripped from the commit description.
+
+FILES
+-----
+'.mailmap'::
+ If this file exists, it will be used for mapping author email
+ addresses to a real author name. One mapping per line, first
+ the author name followed by the email address enclosed by
+ '<' and '>'. Use hash '#' for comments. Example:
+
+ # Keep alphabetized
+ Adam Morrow <adam@localhost.localdomain>
+ Eve Jones <eve@laptop.(none)>
Author
------