git-send-email: ask what to do with an invalid email address
[git/mjg.git] / Documentation / git-shortlog.txt
blobafeb4cdf16df91f63197d390fdbf1540eff66837
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>]]]] <commit>...
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 title.
19 Additionally, "[PATCH]" will be stripped from the commit description.
21 If no revisions are passed on the command line and either standard input
22 is not a terminal or there is no current branch, 'git shortlog' will
23 output a summary of the log read from standard input, without
24 reference to the current repository.
26 OPTIONS
27 -------
29 -h::
30 --help::
31         Print a short usage message and exit.
33 -n::
34 --numbered::
35         Sort output according to the number of commits per author instead
36         of author alphabetic order.
38 -s::
39 --summary::
40         Suppress commit description and provide a commit count summary only.
42 -e::
43 --email::
44         Show the email address of each author.
46 --format[=<format>]::
47         Instead of the commit subject, use some other information to
48         describe each commit.  '<format>' can be any string accepted
49         by the `--format` option of 'git log', such as '* [%h] %s'.
50         (See the "PRETTY FORMATS" section of linkgit:git-log[1].)
52         Each pretty-printed commit will be rewrapped before it is shown.
54 -w[<width>[,<indent1>[,<indent2>]]]::
55         Linewrap the output by wrapping each line at `width`.  The first
56         line of each entry is indented by `indent1` spaces, and the second
57         and subsequent lines are indented by `indent2` spaces. `width`,
58         `indent1`, and `indent2` default to 76, 6 and 9 respectively.
61 MAPPING AUTHORS
62 ---------------
64 The `.mailmap` feature is used to coalesce together commits by the same
65 person in the shortlog, where their name and/or email address was
66 spelled differently.
68 include::mailmap.txt[]
70 GIT
71 ---
72 Part of the linkgit:git[1] suite