1GIT-SHORTLOG(1) Git Manual GIT-SHORTLOG(1)
2
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>]]]] <commit>...
11
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 Additionally, "[PATCH]" will be stripped from the commit description.
19 If no revisions are passed on the command line and either standard
21 input is not a terminal or there is no current branch, git shortlog
22 will output a summary of the log read from standard input, without
23 reference to the current repository.
24
26 -h, --help
27 Print a short usage message and exit.
28 -n, --numbered
30 Sort output according to the number of commits per author instead
31 of author alphabetic order.
32 -s, --summary
34 Suppress commit description and provide a commit count summary
35 only.
36 -e, --email
38 Show the email address of each author.
39 --format[=<format>]
41 Instead of the commit subject, use some other information to
42 describe each commit. <format> can be any string accepted by the
43 --format option of git log, such as * [%h] %s. (See the "PRETTY
44 FORMATS" section of git-log(1).)
45 Each pretty-printed commit will be rewrapped before it is shown.
47 -w[<width>[,<indent1>[,<indent2>]]]
49 Linewrap the output by wrapping each line at width. The first line
50 of each entry is indented by indent1 spaces, and the second and
51 subsequent lines are indented by indent2 spaces. width, indent1,
52 and indent2 default to 76, 6 and 9 respectively.
53
55 The .mailmap feature is used to coalesce together commits by the same
56 person in the shortlog, where their name and/or email address was
57 spelled differently.
58 If the file .mailmap exists at the toplevel of the repository, or at
60 the location pointed to by the mailmap.file configuration option, it is
61 used to map author and committer names and email addresses to canonical
62 real names and email addresses.
63 In the simple form, each line in the file consists of the canonical
65 real name of an author, whitespace, and an email address used in the
66 commit (enclosed by < and >) to map to the name. For example:
67 Proper Name <commit@email.xx>
69 The more complex forms are:
71 <proper@email.xx> <commit@email.xx>
73 which allows mailmap to replace only the email part of a commit, and:
75 Proper Name <proper@email.xx> <commit@email.xx>
77 which allows mailmap to replace both the name and the email of a commit
79 matching the specified commit email address, and:
80 Proper Name <proper@email.xx> Commit Name <commit@email.xx>
82 which allows mailmap to replace both the name and the email of a commit
84 matching both the specified commit name and email address.
85 Example 1: Your history contains commits by two authors, Jane and Joe,
87 whose names appear in the repository under several forms:
88 Joe Developer <joe@example.com>
90 Joe R. Developer <joe@example.com>
91 Jane Doe <jane@example.com>
92 Jane Doe <jane@laptop.(none)>
93 Jane D. <jane@desktop.(none)>
94 Now suppose that Joe wants his middle name initial used, and Jane
97 prefers her family name fully spelled out. A proper .mailmap file would
98 look like:
99 Jane Doe <jane@desktop.(none)>
101 Joe R. Developer <joe@example.com>
102 Note how there is no need for an entry for <jane@laptop[1].(none)>,
105 because the real name of that author is already correct.
106 Example 2: Your repository contains commits from the following authors:
108 nick1 <bugs@company.xx>
110 nick2 <bugs@company.xx>
111 nick2 <nick2@company.xx>
112 santa <me@company.xx>
113 claus <me@company.xx>
114 CTO <cto@coompany.xx>
115 Then you might want a .mailmap file that looks like:
118 <cto@company.xx> <cto@coompany.xx>
120 Some Dude <some@dude.xx> nick1 <bugs@company.xx>
121 Other Author <other@author.xx> nick2 <bugs@company.xx>
122 Other Author <other@author.xx> <nick2@company.xx>
123 Santa Claus <santa.claus@northpole.xx> <me@company.xx>
124 Use hash # for comments that are either on their own line, or after the
127 email address.
128
130 Written by Jeff Garzik <jgarzik@pobox.com[2]>
131
133 Documentation by Junio C Hamano.
134
136 Part of the git(1) suite
137
139 1. jane@laptop
140 mailto:jane@laptop
141 2. jgarzik@pobox.com
143 mailto:jgarzik@pobox.com
144Git 1.7.4.4 04/11/2011 GIT-SHORTLOG(1)