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 shortlog' [<options>] [<revision range>] [[--] <path>...]
  12 git log --pretty=short | 'git shortlog' [<options>]
  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 title.
  18
  19 Additionally, "[PATCH]" will be stripped from the commit description.
  20
  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.
  25
  26 OPTIONS
  27 -------
  28
  29 -n::
  30 --numbered::
  31         Sort output according to the number of commits per author instead
  32         of author alphabetic order.
  33
  34 -s::
  35 --summary::
  36         Suppress commit description and provide a commit count summary only.
  37
  38 -e::
  39 --email::
  40         Show the email address of each author.
  41
  42 --format[=<format>]::
  43         Instead of the commit subject, use some other information to
  44         describe each commit.  '<format>' can be any string accepted
  45         by the `--format` option of 'git log', such as '* [%h] %s'.
  46         (See the "PRETTY FORMATS" section of linkgit:git-log[1].)
  47
  48         Each pretty-printed commit will be rewrapped before it is shown.
  49
  50 --group=<type>::
  51         Group commits based on `<type>`. If no `--group` option is
  52         specified, the default is `author`. `<type>` is one of:
  53 +
  54  - `author`, commits are grouped by author
  55  - `committer`, commits are grouped by committer (the same as `-c`)
  56  - `trailer:<field>`, the `<field>` is interpreted as a case-insensitive
  57    commit message trailer (see linkgit:git-interpret-trailers[1]). For
  58    example, if your project uses `Reviewed-by` trailers, you might want
  59    to see who has been reviewing with
  60    `git shortlog -ns --group=trailer:reviewed-by`.
  61 +
  62 Note that commits that do not include the trailer will not be counted.
  63 Likewise, commits with multiple trailers (e.g., multiple signoffs) may
  64 be counted more than once (but only once per unique trailer value in
  65 that commit).
  66 +
  67 The contents of each trailer value are taken literally and completely.
  68 No mailmap is applied, and the `-e` option has no effect (if the trailer
  69 contains a username and email, they are both always shown).
  70
  71 -c::
  72 --committer::
  73         This is an alias for `--group=committer`.
  74
  75 -w[<width>[,<indent1>[,<indent2>]]]::
  76         Linewrap the output by wrapping each line at `width`.  The first
  77         line of each entry is indented by `indent1` spaces, and the second
  78         and subsequent lines are indented by `indent2` spaces. `width`,
  79         `indent1`, and `indent2` default to 76, 6 and 9 respectively.
  80 +
  81 If width is `0` (zero) then indent the lines of the output without wrapping
  82 them.
  83
  84 <revision range>::
  85         Show only commits in the specified revision range.  When no
  86         <revision range> is specified, it defaults to `HEAD` (i.e. the
  87         whole history leading to the current commit).  `origin..HEAD`
  88         specifies all the commits reachable from the current commit
  89         (i.e. `HEAD`), but not from `origin`. For a complete list of
  90         ways to spell <revision range>, see the "Specifying Ranges"
  91         section of linkgit:gitrevisions[7].
  92
  93 [--] <path>...::
  94         Consider only commits that are enough to explain how the files
  95         that match the specified paths came to be.
  96 +
  97 Paths may need to be prefixed with `--` to separate them from
  98 options or the revision range, when confusion arises.
  99
 100 :git-shortlog: 1
 101 include::rev-list-options.txt[]
 102
 103 MAPPING AUTHORS
 104 ---------------
 105
 106 The `.mailmap` feature is used to coalesce together commits by the same
 107 person in the shortlog, where their name and/or email address was
 108 spelled differently.
 109
 110 include::mailmap.txt[]
 111
 112 GIT
 113 ---
 114 Part of the linkgit:git[1] suite