Documentation: don't reference non-existent 'git-cvsapplycommit'
[gitweb.git] / Documentation / git-shortlog.txt
index 7486ebe785733a6d4f4e1a3a2ea8f5c37b3f0a51..15cc6f77c1e9b8a77c8396fab99cf9d9fda98ef3 100644 (file)
@@ -7,19 +7,35 @@ git-shortlog - Summarize 'git log' output
 
 SYNOPSIS
 --------
-git-log --pretty=short | 'git-shortlog'
+[verse]
+git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s]
+git-shortlog [-n|--numbered] [-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, \--help::
+       Print a short usage message and exit.
+
+-n, \--numbered::
+       Sort output according to the number of commits per author instead
+       of author alphabetic order.
+
+-s, \--summary::
+       Suppress commit description and provide a commit count summary only.
+
 FILES
 -----
-'.mailmap'::
+
+.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