git-[short]log.txt: unify quoted standalone --
[git/git.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 shortlog' [<options>] [<revision range>] [[--] <path>...]
12 git log --pretty=short | 'git shortlog' [<options>]
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 title.
18
19 Additionally, "[PATCH]" will be stripped from the commit description.
20
21 If no revisions are passed on the command line and either standard input
22 is not a terminal or there is no current branch, 'git shortlog' will
23 output a summary of the log read from standard input, without
24 reference to the current repository.
25
26 OPTIONS
27 -------
28
29 -n::
30 --numbered::
31 Sort output according to the number of commits per author instead
32 of author alphabetic order.
33
34 -s::
35 --summary::
36 Suppress commit description and provide a commit count summary only.
37
38 -e::
39 --email::
40 Show the email address of each author.
41
42 --format[=<format>]::
43 Instead of the commit subject, use some other information to
44 describe each commit. '<format>' can be any string accepted
45 by the `--format` option of 'git log', such as '* [%h] %s'.
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
50 -c::
51 --committer::
52 Collect and show committer identities instead of authors.
53
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.
59 +
60 If width is `0` (zero) then indent the lines of the output without wrapping
61 them.
62
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
72 [--] <path>...::
73 Consider only commits that are enough to explain how the files
74 that match the specified paths came to be.
75 +
76 Paths may need to be prefixed with `--` to separate them from
77 options or the revision range, when confusion arises.
78
79 MAPPING AUTHORS
80 ---------------
81
82 The `.mailmap` feature is used to coalesce together commits by the same
83 person in the shortlog, where their name and/or email address was
84 spelled differently.
85
86 include::mailmap.txt[]
87
88 GIT
89 ---
90 Part of the linkgit:git[1] suite