add commit count options to git-shortlog

[git.git] / Documentation / git-shortlog.txt

diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index 6968ca6060a075bdd2a53776f353dfabb444fc88..1601d2267c34fec24ab527caa55d35a3c52c8063 100644 (file)
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -1,21 +1,46 @@
 git-shortlog(1)
 ===============
-v0.99.4, Aug 2005
 
 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]
 
 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
 ------
@@ -27,5 +52,5 @@ Documentation by Junio C Hamano.
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite