rebased and brought code up to speed with v1.6.2 code base
[git/mingw/4msysgit/wingit-dll.git] / Documentation / git-shortlog.txt
blob42463a955dd3f5dad25f3a45f0eec62d8712f731
1 git-shortlog(1)
2 ===============
4 NAME
5 ----
6 git-shortlog - Summarize 'git-log' output
8 SYNOPSIS
9 --------
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>]]]] [<committish>...]
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.
20 Additionally, "[PATCH]" will be stripped from the commit description.
22 OPTIONS
23 -------
25 -h::
26 --help::
27         Print a short usage message and exit.
29 -n::
30 --numbered::
31         Sort output according to the number of commits per author instead
32         of author alphabetic order.
34 -s::
35 --summary::
36         Suppress commit description and provide a commit count summary only.
38 -e::
39 --email::
40         Show the email address of each author.
42 -w[<width>[,<indent1>[,<indent2>]]]::
43         Linewrap the output by wrapping each line at `width`.  The first
44         line of each entry is indented by `indent1` spaces, and the second
45         and subsequent lines are indented by `indent2` spaces. `width`,
46         `indent1`, and `indent2` default to 76, 6 and 9 respectively.
49 MAPPING AUTHORS
50 ---------------
52 The `.mailmap` feature is used to coalesce together commits by the same
53 person in the shortlog, where their name and/or email address was
54 spelled differently.
56 include::mailmap.txt[]
59 Author
60 ------
61 Written by Jeff Garzik <jgarzik@pobox.com>
63 Documentation
64 --------------
65 Documentation by Junio C Hamano.
67 GIT
68 ---
69 Part of the linkgit:git[1] suite