blob: afeb4cdf16df91f63197d390fdbf1540eff66837 [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 Hamanofce7c7e2008-07-02 03:06:3811git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
Junio C Hamanocc7636a2010-05-21 14:57:5312'git shortlog' [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] <commit>...
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-h::
30--help::
Junio C Hamano5f1dfc72006-10-10 04:36:3031Print a short usage message and exit.
32
Junio C Hamanoeb415992008-06-08 22:49:4733-n::
34--numbered::
Junio C Hamano5f1dfc72006-10-10 04:36:3035Sort output according to the number of commits per author instead
36of author alphabetic order.
37
Junio C Hamanoeb415992008-06-08 22:49:4738-s::
39--summary::
Junio C Hamanof9771f62007-01-17 17:42:3040Suppress commit description and provide a commit count summary only.
Junio C Hamano5f1dfc72006-10-10 04:36:3041
Junio C Hamanoeb415992008-06-08 22:49:4742-e::
43--email::
Junio C Hamano0c0da5f2007-12-13 02:45:3044Show the email address of each author.
45
Junio C Hamanod2179ef2010-10-22 04:12:1746--format[=<format>]::
Junio C Hamanocc7636a2010-05-21 14:57:5347Instead of the commit subject, use some other information to
48describe each commit. '<format>' can be any string accepted
Junio C Hamanob76a6862012-05-02 22:02:4649by the `--format` option of 'git log', such as '* [%h] %s'.
Junio C Hamanocc7636a2010-05-21 14:57:5350(See the "PRETTY FORMATS" section of linkgit:git-log[1].)
51
52Each pretty-printed commit will be rewrapped before it is shown.
53
Junio C Hamano1bdd3b02008-04-13 05:33:1854-w[<width>[,<indent1>[,<indent2>]]]::
55Linewrap the output by wrapping each line at `width`. The first
56line of each entry is indented by `indent1` spaces, and the second
57and subsequent lines are indented by `indent2` spaces. `width`,
58`indent1`, and `indent2` default to 76, 6 and 9 respectively.
59
Junio C Hamanob6bd6ce2007-04-18 23:54:2860
Junio C Hamano8bc410e2009-02-15 10:38:1961MAPPING AUTHORS
62---------------
Junio C Hamano2fa431b2008-12-28 01:26:2363
Junio C Hamano8bc410e2009-02-15 10:38:1964The `.mailmap` feature is used to coalesce together commits by the same
65person in the shortlog, where their name and/or email address was
66spelled differently.
Junio C Hamano2fa431b2008-12-28 01:26:2367
Junio C Hamano8bc410e2009-02-15 10:38:1968include::mailmap.txt[]
Junio C Hamano2fa431b2008-12-28 01:26:2369
Junio C Hamano1a4e8412005-12-27 08:17:2370GIT
71---
Junio C Hamanof7c042d2008-06-06 22:50:5372Part of the linkgit:git[1] suite