i18n: grep: mark parseopt strings for translation
[git/jnareb-git.git] / Documentation / git-shortlog.txt
blob01d8417316e23bc74f2c86df9004091710437ba7
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
18 the first line of the commit message will be shown.
20 Additionally, "[PATCH]" will be stripped from the commit description.
22 If no revisions are passed on the command line and either standard input
23 is not a terminal or there is no current branch, 'git shortlog' will
24 output a summary of the log read from standard input, without
25 reference to the current repository.
27 OPTIONS
28 -------
30 -h::
31 --help::
32         Print a short usage message and exit.
34 -n::
35 --numbered::
36         Sort output according to the number of commits per author instead
37         of author alphabetic order.
39 -s::
40 --summary::
41         Suppress commit description and provide a commit count summary only.
43 -e::
44 --email::
45         Show the email address of each author.
47 --format[=<format>]::
48         Instead of the commit subject, use some other information to
49         describe each commit.  '<format>' can be any string accepted
50         by the `--format` option of 'git log', such as '* [%h] %s'.
51         (See the "PRETTY FORMATS" section of linkgit:git-log[1].)
53         Each pretty-printed commit will be rewrapped before it is shown.
55 -w[<width>[,<indent1>[,<indent2>]]]::
56         Linewrap the output by wrapping each line at `width`.  The first
57         line of each entry is indented by `indent1` spaces, and the second
58         and subsequent lines are indented by `indent2` spaces. `width`,
59         `indent1`, and `indent2` default to 76, 6 and 9 respectively.
62 MAPPING AUTHORS
63 ---------------
65 The `.mailmap` feature is used to coalesce together commits by the same
66 person in the shortlog, where their name and/or email address was
67 spelled differently.
69 include::mailmap.txt[]
71 GIT
72 ---
73 Part of the linkgit:git[1] suite