X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-shortlog.txt;h=95fa9010c1539e4c93d6d402ffd4bb670fd32910;hb=0d313b2b7bb219542473a25ad042f4b990e69a45;hp=65ca77fbf657520a59b308fc3e99ed79b61cff95;hpb=1301c6eb412e7c5511b952a12e42c70ad56f028b;p=git.git

diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index 65ca77fbf..95fa9010c 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -3,18 +3,45 @@ 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' [-h] [-n] [-s]
+git-shortlog [-n|--number] [-s|--summary] [<committish>...]
 
 DESCRIPTION
 -----------
 Summarizes 'git log' output in a format suitable for inclusion
-in release announcements.
+in release announcements. Each commit will be grouped by author and
+the first line of the commit message will be shown.
+
+Additionally, "[PATCH]" will be stripped from the commit description.
+
+OPTIONS
+-------
+
+-h::
+	Print a short usage message and exit.
+
+-n::
+	Sort output according to the number of commits per author instead
+	of author alphabetic order.
+
+-s::
+	Supress commit description and provide a commit count summary only.
+
+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
 ------