blob: 31af7f27360d277ccdc3e5bd59b4788c83934b8e [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231git-shortlog(1)
2===============
3
4NAME
5----
Junio C Hamano1aa40d22010-01-21 17:46:436git-shortlog - Summarize 'git log' output
Junio C Hamano1a4e8412005-12-27 08:17:237
Junio C Hamano1a4e8412005-12-27 08:17:238SYNOPSIS
9--------
Junio C Hamanob6bd6ce2007-04-18 23:54:2810[verse]
Junio C Hamanof26c77e2013-04-27 00:06:0411git log --pretty=short | 'git shortlog' [<options>]
12'git shortlog' [<options>] [<revision range>] [[\--] <path>...]
Junio C Hamano1a4e8412005-12-27 08:17:2313
14DESCRIPTION
15-----------
Junio C Hamano1aa40d22010-01-21 17:46:4316Summarizes 'git log' output in a format suitable for inclusion
Junio C Hamano281fd392012-09-17 23:57:4117in release announcements. Each commit will be grouped by author and title.
Junio C Hamano1a4e8412005-12-27 08:17:2318
Junio C Hamano33db4372006-06-07 19:51:4519Additionally, "[PATCH]" will be stripped from the commit description.
20
Junio C Hamanocc7636a2010-05-21 14:57:5321If 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
Junio C Hamano5f1dfc72006-10-10 04:36:3026OPTIONS
27-------
28
Junio C Hamanoeb415992008-06-08 22:49:4729-n::
30--numbered::
Junio C Hamano5f1dfc72006-10-10 04:36:3031Sort output according to the number of commits per author instead
32of author alphabetic order.
33
Junio C Hamanoeb415992008-06-08 22:49:4734-s::
35--summary::
Junio C Hamanof9771f62007-01-17 17:42:3036Suppress commit description and provide a commit count summary only.
Junio C Hamano5f1dfc72006-10-10 04:36:3037
Junio C Hamanoeb415992008-06-08 22:49:4738-e::
39--email::
Junio C Hamano0c0da5f2007-12-13 02:45:3040Show the email address of each author.
41
Junio C Hamanod2179ef2010-10-22 04:12:1742--format[=<format>]::
Junio C Hamanocc7636a2010-05-21 14:57:5343Instead of the commit subject, use some other information to
44describe each commit. '<format>' can be any string accepted
Junio C Hamanob76a6862012-05-02 22:02:4645by the `--format` option of 'git log', such as '* [%h] %s'.
Junio C Hamanocc7636a2010-05-21 14:57:5346(See the "PRETTY FORMATS" section of linkgit:git-log[1].)
47
48Each pretty-printed commit will be rewrapped before it is shown.
49
Junio C Hamano1bdd3b02008-04-13 05:33:1850-w[<width>[,<indent1>[,<indent2>]]]::
51Linewrap the output by wrapping each line at `width`. The first
52line of each entry is indented by `indent1` spaces, and the second
53and subsequent lines are indented by `indent2` spaces. `width`,
54`indent1`, and `indent2` default to 76, 6 and 9 respectively.
Junio C Hamano7dac6902013-01-12 08:25:3155+
56If width is `0` (zero) then indent the lines of the output without wrapping
57them.
Junio C Hamano1bdd3b02008-04-13 05:33:1858
Junio C Hamanof26c77e2013-04-27 00:06:0459<revision range>::
60Show only commits in the specified revision range. When no
61<revision range> is specified, it defaults to `HEAD` (i.e. the
62whole history leading to the current commit). `origin..HEAD`
63specifies all the commits reachable from the current commit
64(i.e. `HEAD`), but not from `origin`. For a complete list of
65ways to spell <revision range>, see the "Specifying Ranges"
66section of linkgit:gitrevisions[7].
67
68[\--] <path>...::
69Consider only commits that are enough to explain how the files
70that match the specified paths came to be.
71+
72Paths may need to be prefixed with "\-- " to separate them from
73options or the revision range, when confusion arises.
Junio C Hamanob6bd6ce2007-04-18 23:54:2874
Junio C Hamano8bc410e2009-02-15 10:38:1975MAPPING AUTHORS
76---------------
Junio C Hamano2fa431b2008-12-28 01:26:2377
Junio C Hamano8bc410e2009-02-15 10:38:1978The `.mailmap` feature is used to coalesce together commits by the same
79person in the shortlog, where their name and/or email address was
80spelled differently.
Junio C Hamano2fa431b2008-12-28 01:26:2381
Junio C Hamano8bc410e2009-02-15 10:38:1982include::mailmap.txt[]
Junio C Hamano2fa431b2008-12-28 01:26:2383
Junio C Hamano1a4e8412005-12-27 08:17:2384GIT
85---
Junio C Hamanof7c042d2008-06-06 22:50:5386Part of the linkgit:git[1] suite