git-submodule: rename shell functions for consistency
[git] / Documentation / git-shortlog.txt
1 git-shortlog(1)
2 ===============
3
4 NAME
5 ----
6 git-shortlog - Summarize 'git log' output
7
8 SYNOPSIS
9 --------
10 [verse]
11 git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s] [-e]
12 git-shortlog [-n|--numbered] [-s|--summary] [-e|--email] [<committish>...]
13
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.
19
20 Additionally, "[PATCH]" will be stripped from the commit description.
21
22 OPTIONS
23 -------
24
25 -h, \--help::
26         Print a short usage message and exit.
27
28 -n, \--numbered::
29         Sort output according to the number of commits per author instead
30         of author alphabetic order.
31
32 -s, \--summary::
33         Suppress commit description and provide a commit count summary only.
34
35 -e, \--email::
36         Show the email address of each author.
37
38 FILES
39 -----
40
41 If the file `.mailmap` exists, it will be used for mapping author
42 email addresses to a real author name. One mapping per line, first
43 the author name followed by the email address enclosed by
44 '<' and '>'. Use hash '#' for comments. Example:
45
46 ------------
47 # Keep alphabetized
48 Adam Morrow <adam@localhost.localdomain>
49 Eve Jones <eve@laptop.(none)>
50 ------------
51
52 Author
53 ------
54 Written by Jeff Garzik <jgarzik@pobox.com>
55
56 Documentation
57 --------------
58 Documentation by Junio C Hamano.
59
60 GIT
61 ---
62 Part of the linkgit:git[7] suite