Merge branch 'jc/am'
[gitweb.git] / Documentation / git-shortlog.txt
index 696a4245b5ca6cc49a9dcaa346d8a0e7453e44b0..7486ebe785733a6d4f4e1a3a2ea8f5c37b3f0a51 100644 (file)
@@ -3,18 +3,31 @@ git-shortlog(1)
 
 NAME
 ----
-git-shortlog - Summarize 'git log' output.
-
+git-shortlog - Summarize 'git log' output
 
 SYNOPSIS
 --------
-'git log --pretty=short | git shortlog'
+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
 ------