1GIT-SHORTLOG(1) Git Manual GIT-SHORTLOG(1)
2
3
4
6 git-shortlog - Summarize ´git log´ output
7
9 git log --pretty=short | git shortlog [-h] [-n] [-s] [-e] [-w]
10 git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
11
12
14 Summarizes git log output in a format suitable for inclusion in release
15 announcements. Each commit will be grouped by author and the first line
16 of the commit message will be shown.
17
18 Additionally, "[PATCH]" will be stripped from the commit description.
19
21 -h, --help
22 Print a short usage message and exit.
23
24 -n, --numbered
25 Sort output according to the number of commits per author instead
26 of author alphabetic order.
27
28 -s, --summary
29 Suppress commit description and provide a commit count summary
30 only.
31
32 -e, --email
33 Show the email address of each author.
34
35 -w[<width>[,<indent1>[,<indent2>]]]
36 Linewrap the output by wrapping each line at width. The first line
37 of each entry is indented by indent1 spaces, and the second and
38 subsequent lines are indented by indent2 spaces. width, indent1,
39 and indent2 default to 76, 6 and 9 respectively.
40
42 The .mailmap feature is used to coalesce together commits by the same
43 person in the shortlog, where their name and/or email address was
44 spelled differently.
45
46 If the file .mailmap exists at the toplevel of the repository, or at
47 the location pointed to by the mailmap.file configuration option, it is
48 used to map author and committer names and email addresses to canonical
49 real names and email addresses.
50
51 In the simple form, each line in the file consists of the canonical
52 real name of an author, whitespace, and an email address used in the
53 commit (enclosed by < and >) to map to the name. For example:
54
55 Proper Name <commit@email.xx>
56
57 The more complex forms are:
58
59 <proper@email.xx> <commit@email.xx>
60
61 which allows mailmap to replace only the email part of a commit, and:
62
63 Proper Name <proper@email.xx> <commit@email.xx>
64
65 which allows mailmap to replace both the name and the email of a commit
66 matching the specified commit email address, and:
67
68 Proper Name <proper@email.xx> Commit Name <commit@email.xx>
69
70 which allows mailmap to replace both the name and the email of a commit
71 matching both the specified commit name and email address.
72
73 Example 1: Your history contains commits by two authors, Jane and Joe,
74 whose names appear in the repository under several forms:
75
76 Joe Developer <joe@example.com>
77 Joe R. Developer <joe@example.com>
78 Jane Doe <jane@example.com>
79 Jane Doe <jane@laptop.(none)>
80 Jane D. <jane@desktop.(none)>
81
82
83 Now suppose that Joe wants his middle name initial used, and Jane
84 prefers her family name fully spelled out. A proper .mailmap file would
85 look like:
86
87 Jane Doe <jane@desktop.(none)>
88 Joe R. Developer <joe@example.com>
89
90
91 Note how there is no need for an entry for <jane@laptop[1].(none)>,
92 because the real name of that author is already correct.
93
94 Example 2: Your repository contains commits from the following authors:
95
96 nick1 <bugs@company.xx>
97 nick2 <bugs@company.xx>
98 nick2 <nick2@company.xx>
99 santa <me@company.xx>
100 claus <me@company.xx>
101 CTO <cto@coompany.xx>
102
103
104 Then you might want a .mailmap file that looks like:
105
106 <cto@company.xx> <cto@coompany.xx>
107 Some Dude <some@dude.xx> nick1 <bugs@company.xx>
108 Other Author <other@author.xx> nick2 <bugs@company.xx>
109 Other Author <other@author.xx> <nick2@company.xx>
110 Santa Claus <santa.claus@northpole.xx> <me@company.xx>
111
112
113 Use hash # for comments that are either on their own line, or after the
114 email address.
115
117 Written by Jeff Garzik <jgarzik@pobox.com[2]>
118
120 Documentation by Junio C Hamano.
121
123 Part of the git(1) suite
124
126 1. jane@laptop
127 mailto:jane@laptop
128
129 2. jgarzik@pobox.com
130 mailto:jgarzik@pobox.com
131
132
133
134Git 1.7.1 08/16/2017 GIT-SHORTLOG(1)