git-shortlog(1)

1GIT-SHORTLOG(1)                   Git Manual                   GIT-SHORTLOG(1)
2
3
4

NAME

6       git-shortlog - Summarize 'git log' output
7

SYNOPSIS

9       git log --pretty=short | git shortlog [<options>]
10       git shortlog [<options>] [<revision range>] [[--] <path>...]
11
12

DESCRIPTION

14       Summarizes git log output in a format suitable for inclusion in release
15       announcements. Each commit will be grouped by author and title.
16
17       Additionally, "[PATCH]" will be stripped from the commit description.
18
19       If no revisions are passed on the command line and either standard
20       input is not a terminal or there is no current branch, git shortlog
21       will output a summary of the log read from standard input, without
22       reference to the current repository.
23

OPTIONS

25       -n, --numbered
26           Sort output according to the number of commits per author instead
27           of author alphabetic order.
28
29       -s, --summary
30           Suppress commit description and provide a commit count summary
31           only.
32
33       -e, --email
34           Show the email address of each author.
35
36       --format[=<format>]
37           Instead of the commit subject, use some other information to
38           describe each commit.  <format> can be any string accepted by the
39           --format option of git log, such as * [%h] %s. (See the "PRETTY
40           FORMATS" section of git-log(1).)
41
42               Each pretty-printed commit will be rewrapped before it is shown.
43
44       -w[<width>[,<indent1>[,<indent2>]]]
45           Linewrap the output by wrapping each line at width. The first line
46           of each entry is indented by indent1 spaces, and the second and
47           subsequent lines are indented by indent2 spaces.  width, indent1,
48           and indent2 default to 76, 6 and 9 respectively.
49
50           If width is 0 (zero) then indent the lines of the output without
51           wrapping them.
52
53       <revision range>
54           Show only commits in the specified revision range. When no
55           <revision range> is specified, it defaults to HEAD (i.e. the whole
56           history leading to the current commit).  origin..HEAD specifies all
57           the commits reachable from the current commit (i.e.  HEAD), but not
58           from origin. For a complete list of ways to spell <revision range>,
59           see the "Specifying Ranges" section of gitrevisions(7).
60
61       [--] <path>...
62           Consider only commits that are enough to explain how the files that
63           match the specified paths came to be.
64
65           Paths may need to be prefixed with "-- " to separate them from
66           options or the revision range, when confusion arises.
67

MAPPING AUTHORS

69       The .mailmap feature is used to coalesce together commits by the same
70       person in the shortlog, where their name and/or email address was
71       spelled differently.
72
73       If the file .mailmap exists at the toplevel of the repository, or at
74       the location pointed to by the mailmap.file or mailmap.blob
75       configuration options, it is used to map author and committer names and
76       email addresses to canonical real names and email addresses.
77
78       In the simple form, each line in the file consists of the canonical
79       real name of an author, whitespace, and an email address used in the
80       commit (enclosed by < and >) to map to the name. For example:
81
82           Proper Name <commit@email.xx>
83
84       The more complex forms are:
85
86           <proper@email.xx> <commit@email.xx>
87
88       which allows mailmap to replace only the email part of a commit, and:
89
90           Proper Name <proper@email.xx> <commit@email.xx>
91
92       which allows mailmap to replace both the name and the email of a commit
93       matching the specified commit email address, and:
94
95           Proper Name <proper@email.xx> Commit Name <commit@email.xx>
96
97       which allows mailmap to replace both the name and the email of a commit
98       matching both the specified commit name and email address.
99
100       Example 1: Your history contains commits by two authors, Jane and Joe,
101       whose names appear in the repository under several forms:
102
103           Joe Developer <joe@example.com>
104           Joe R. Developer <joe@example.com>
105           Jane Doe <jane@example.com>
106           Jane Doe <jane@laptop.(none)>
107           Jane D. <jane@desktop.(none)>
108
109
110       Now suppose that Joe wants his middle name initial used, and Jane
111       prefers her family name fully spelled out. A proper .mailmap file would
112       look like:
113
114           Jane Doe         <jane@desktop.(none)>
115           Joe R. Developer <joe@example.com>
116
117
118       Note how there is no need for an entry for <jane@laptop.(none)>,
119       because the real name of that author is already correct.
120
121       Example 2: Your repository contains commits from the following authors:
122
123           nick1 <bugs@company.xx>
124           nick2 <bugs@company.xx>
125           nick2 <nick2@company.xx>
126           santa <me@company.xx>
127           claus <me@company.xx>
128           CTO <cto@coompany.xx>
129
130
131       Then you might want a .mailmap file that looks like:
132
133           <cto@company.xx>                       <cto@coompany.xx>
134           Some Dude <some@dude.xx>         nick1 <bugs@company.xx>
135           Other Author <other@author.xx>   nick2 <bugs@company.xx>
136           Other Author <other@author.xx>         <nick2@company.xx>
137           Santa Claus <santa.claus@northpole.xx> <me@company.xx>
138
139
140       Use hash # for comments that are either on their own line, or after the
141       email address.
142

GIT

144       Part of the git(1) suite
145
146
147
148Git 1.8.3.1                       11/19/2018                   GIT-SHORTLOG(1)