Documentation / grammer nit
[git/mingw.git] / Documentation / git-shortlog.txt
blob2220ef6ea8d3bfa58f3c1279dfcf4f735c2dae0a
1 git-shortlog(1)
2 ===============
4 NAME
5 ----
6 git-shortlog - Summarize 'git log' output
8 SYNOPSIS
9 --------
10 [verse]
11 git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s]
12 git-shortlog [-n|--numbered] [-s|--summary] [<committish>...]
14 DESCRIPTION
15 -----------
16 Summarizes 'git log' output in a format suitable for inclusion
17 in release announcements. Each commit will be grouped by author and
18 the first line of the commit message will be shown.
20 Additionally, "[PATCH]" will be stripped from the commit description.
22 OPTIONS
23 -------
25 -h, \--help::
26         Print a short usage message and exit.
28 -n, \--numbered::
29         Sort output according to the number of commits per author instead
30         of author alphabetic order.
32 -s, \--summary::
33         Suppress commit description and provide a commit count summary only.
35 FILES
36 -----
38 .mailmap::
39         If this file exists, it will be used for mapping author email
40         addresses to a real author name. One mapping per line, first
41         the author name followed by the email address enclosed by
42         '<' and '>'. Use hash '#' for comments. Example:
44                 # Keep alphabetized
45                 Adam Morrow <adam@localhost.localdomain>
46                 Eve Jones <eve@laptop.(none)>
48 Author
49 ------
50 Written by Jeff Garzik <jgarzik@pobox.com>
52 Documentation
53 --------------
54 Documentation by Junio C Hamano.
56 GIT
57 ---
58 Part of the gitlink:git[7] suite