summaryrefslogtreecommitdiff
path: root/Documentation/git-shortlog.txt
blob: ecf9e2718c1e6c720ca1155607c192100cdf4663 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
git-shortlog(1)
===============
 
NAME
----
git-shortlog - Summarize 'git log' output
 
SYNOPSIS
--------
[verse]
git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
 
DESCRIPTION
-----------
Summarizes 'git log' output in a format suitable for inclusion
in release announcements. Each commit will be grouped by author and
the first line of the commit message will be shown.
 
Additionally, "[PATCH]" will be stripped from the commit description.
 
OPTIONS
-------
 
-h::
--help::
	Print a short usage message and exit.
 
-n::
--numbered::
	Sort output according to the number of commits per author instead
	of author alphabetic order.
 
-s::
--summary::
	Suppress commit description and provide a commit count summary only.
 
-e::
--email::
	Show the email address of each author.
 
-w[<width>[,<indent1>[,<indent2>]]]::
	Linewrap the output by wrapping each line at `width`.  The first
	line of each entry is indented by `indent1` spaces, and the second
	and subsequent lines are indented by `indent2` spaces. `width`,
	`indent1`, and `indent2` default to 76, 6 and 9 respectively.
 
 
MAPPING AUTHORS
---------------
 
The `.mailmap` feature is used to coalesce together commits by the same
person in the shortlog, where their name and/or email address was
spelled differently.
 
include::mailmap.txt[]
 
 
Author
------
Written by Jeff Garzik <jgarzik@pobox.com>
 
Documentation
--------------
Documentation by Junio C Hamano.
 
GIT
---
Part of the linkgit:git[1] suite