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