git-shortlog.txt 2.0 KB
Newer Older
J
Junio C Hamano 已提交
1 2 3 4 5
git-shortlog(1)
===============

NAME
----
6
git-shortlog - Summarize 'git log' output
J
Junio C Hamano 已提交
7 8 9

SYNOPSIS
--------
10
[verse]
11
git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
12
'git shortlog' [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] <commit>...
J
Junio C Hamano 已提交
13 14 15

DESCRIPTION
-----------
16
Summarizes 'git log' output in a format suitable for inclusion
17
in release announcements. Each commit will be grouped by author and
J
Jonas Fonseca 已提交
18 19 20 21
the first line of the commit message will be shown.

Additionally, "[PATCH]" will be stripped from the commit description.

22 23 24 25 26
If no revisions are passed on the command line and either standard input
is not a terminal or there is no current branch, 'git shortlog' will
output a summary of the log read from standard input, without
reference to the current repository.

27 28 29
OPTIONS
-------

30 31
-h::
--help::
32 33
	Print a short usage message and exit.

34 35
-n::
--numbered::
36 37 38
	Sort output according to the number of commits per author instead
	of author alphabetic order.

39 40
-s::
--summary::
41
	Suppress commit description and provide a commit count summary only.
42

43 44
-e::
--email::
J
Jeff King 已提交
45 46
	Show the email address of each author.

47
--format[=<format>]::
48 49
	Instead of the commit subject, use some other information to
	describe each commit.  '<format>' can be any string accepted
50
	by the `--format` option of 'git log', such as '* [%h] %s'.
51 52 53 54
	(See the "PRETTY FORMATS" section of linkgit:git-log[1].)

	Each pretty-printed commit will be rewrapped before it is shown.

J
Junio C Hamano 已提交
55 56 57 58 59 60
-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.

61 62 63 64 65 66 67 68 69

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[]
70

J
Junio C Hamano 已提交
71 72
GIT
---
73
Part of the linkgit:git[1] suite