Documentation: describe 'union' low-level merge driver
[git/git.git] / Documentation / git-shortlog.txt
1 git-shortlog(1)
2 ===============
3
4 NAME
5 ----
6 git-shortlog - Summarize 'git log' output
7
8 SYNOPSIS
9 --------
10 [verse]
11 git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s] [-e]
12 git-shortlog [-n|--numbered] [-s|--summary] [-e|--email] [<committish>...]
13
14 DESCRIPTION
15 -----------
16 Summarizes 'git log' output in a format suitable for inclusion
17 in release announcements. Each commit will be grouped by author and
18 the first line of the commit message will be shown.
19
20 Additionally, "[PATCH]" will be stripped from the commit description.
21
22 OPTIONS
23 -------
24
25 -h, \--help::
26 Print a short usage message and exit.
27
28 -n, \--numbered::
29 Sort output according to the number of commits per author instead
30 of author alphabetic order.
31
32 -s, \--summary::
33 Suppress commit description and provide a commit count summary only.
34
35 -e, \--email::
36 Show the email address of each author.
37
38 FILES
39 -----
40
41 .mailmap::
42 If this file exists, it will be used for mapping author email
43 addresses to a real author name. One mapping per line, first
44 the author name followed by the email address enclosed by
45 '<' and '>'. Use hash '#' for comments. Example:
46
47 # Keep alphabetized
48 Adam Morrow <adam@localhost.localdomain>
49 Eve Jones <eve@laptop.(none)>
50
51 Author
52 ------
53 Written by Jeff Garzik <jgarzik@pobox.com>
54
55 Documentation
56 --------------
57 Documentation by Junio C Hamano.
58
59 GIT
60 ---
61 Part of the gitlink:git[7] suite