git-[short]log.txt: unify quoted standalone --
[git/git.git] / Documentation / git-shortlog.txt
CommitLineData
3f971fc4
JH
1git-shortlog(1)
2===============
3f971fc4
JH
3
4NAME
5----
0b444cdb 6git-shortlog - Summarize 'git log' output
3f971fc4 7
3f971fc4
JH
8SYNOPSIS
9--------
0ad64fd0 10[verse]
933c758c 11'git shortlog' [<options>] [<revision range>] [[--] <path>...]
a8210328 12git log --pretty=short | 'git shortlog' [<options>]
3f971fc4
JH
13
14DESCRIPTION
15-----------
0b444cdb 16Summarizes 'git log' output in a format suitable for inclusion
52ffe995 17in release announcements. Each commit will be grouped by author and title.
74237d62
JF
18
19Additionally, "[PATCH]" will be stripped from the commit description.
20
02646fe5
JN
21If no revisions are passed on the command line and either standard input
22is not a terminal or there is no current branch, 'git shortlog' will
23output a summary of the log read from standard input, without
24reference to the current repository.
25
4e27fb06
NP
26OPTIONS
27-------
28
3240240f
SB
29-n::
30--numbered::
4e27fb06
NP
31 Sort output according to the number of commits per author instead
32 of author alphabetic order.
33
3240240f
SB
34-s::
35--summary::
23bfbb81 36 Suppress commit description and provide a commit count summary only.
4e27fb06 37
3240240f
SB
38-e::
39--email::
6508bb75
JK
40 Show the email address of each author.
41
efc39d6d 42--format[=<format>]::
60037249
JN
43 Instead of the commit subject, use some other information to
44 describe each commit. '<format>' can be any string accepted
6cf378f0 45 by the `--format` option of 'git log', such as '* [%h] %s'.
60037249
JN
46 (See the "PRETTY FORMATS" section of linkgit:git-log[1].)
47
48 Each pretty-printed commit will be rewrapped before it is shown.
49
03f40829
JK
50-c::
51--committer::
52 Collect and show committer identities instead of authors.
53
55ef8a46
JH
54-w[<width>[,<indent1>[,<indent2>]]]::
55 Linewrap the output by wrapping each line at `width`. The first
56 line of each entry is indented by `indent1` spaces, and the second
57 and subsequent lines are indented by `indent2` spaces. `width`,
58 `indent1`, and `indent2` default to 76, 6 and 9 respectively.
0e82bd04
JK
59+
60If width is `0` (zero) then indent the lines of the output without wrapping
61them.
55ef8a46 62
46b2a46d
RR
63<revision range>::
64 Show only commits in the specified revision range. When no
65 <revision range> is specified, it defaults to `HEAD` (i.e. the
66 whole history leading to the current commit). `origin..HEAD`
67 specifies all the commits reachable from the current commit
68 (i.e. `HEAD`), but not from `origin`. For a complete list of
69 ways to spell <revision range>, see the "Specifying Ranges"
70 section of linkgit:gitrevisions[7].
71
933c758c 72[--] <path>...::
46b2a46d
RR
73 Consider only commits that are enough to explain how the files
74 that match the specified paths came to be.
75+
6955047f 76Paths may need to be prefixed with `--` to separate them from
46b2a46d 77options or the revision range, when confusion arises.
7d48e9e6
MSO
78
79MAPPING AUTHORS
80---------------
81
82The `.mailmap` feature is used to coalesce together commits by the same
83person in the shortlog, where their name and/or email address was
84spelled differently.
85
86include::mailmap.txt[]
0925ce4d 87
3f971fc4
JH
88GIT
89---
9e1f0a85 90Part of the linkgit:git[1] suite