blob: 6e4cbc4fdd37758a7021675bd3e81aea620651cc [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231git-shortlog(1)
2===============
3
4NAME
5----
Junio C Hamano01078922006-03-10 00:31:476git-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]
12git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
Junio C Hamano1a4e8412005-12-27 08:17:2313
14DESCRIPTION
15-----------
Junio C Hamanofce7c7e2008-07-02 03:06:3816Summarizes `git-log` output in a format suitable for inclusion
Junio C Hamano5f1dfc72006-10-10 04:36:3017in release announcements. Each commit will be grouped by author and
Junio C Hamano33db4372006-06-07 19:51:4518the first line of the commit message will be shown.
Junio C Hamano1a4e8412005-12-27 08:17:2319
Junio C Hamano33db4372006-06-07 19:51:4520Additionally, "[PATCH]" will be stripped from the commit description.
21
Junio C Hamano5f1dfc72006-10-10 04:36:3022OPTIONS
23-------
24
Junio C Hamanoeb415992008-06-08 22:49:4725-h::
26--help::
Junio C Hamano5f1dfc72006-10-10 04:36:3027Print a short usage message and exit.
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 Hamano1bdd3b02008-04-13 05:33:1842-w[<width>[,<indent1>[,<indent2>]]]::
43Linewrap the output by wrapping each line at `width`. The first
44line of each entry is indented by `indent1` spaces, and the second
45and subsequent lines are indented by `indent2` spaces. `width`,
46`indent1`, and `indent2` default to 76, 6 and 9 respectively.
47
Junio C Hamano33db4372006-06-07 19:51:4548FILES
49-----
Junio C Hamanob6bd6ce2007-04-18 23:54:2850
Junio C Hamano0ec42932007-12-24 19:31:3951If the file `.mailmap` exists, it will be used for mapping author
52email addresses to a real author name. One mapping per line, first
53the author name followed by the email address enclosed by
54'<' and '>'. Use hash '#' for comments. Example:
Junio C Hamano33db4372006-06-07 19:51:4555
Junio C Hamano0ec42932007-12-24 19:31:3956------------
57# Keep alphabetized
58Adam Morrow <adam@localhost.localdomain>
59Eve Jones <eve@laptop.(none)>
60------------
Junio C Hamano1a4e8412005-12-27 08:17:2361
62Author
63------
64Written by Jeff Garzik <jgarzik@pobox.com>
65
66Documentation
67--------------
68Documentation by Junio C Hamano.
69
70GIT
71---
Junio C Hamanof7c042d2008-06-06 22:50:5372Part of the linkgit:git[1] suite