Merge branch 'jc/commit-careful'
[gitweb.git] / Documentation / git-shortlog.txt
index 7486ebe785733a6d4f4e1a3a2ea8f5c37b3f0a51..95fa9010c1539e4c93d6d402ffd4bb670fd32910 100644 (file)
@@ -7,16 +7,30 @@ 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. Each commit will be grouped by author
+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'::