Documentation / git-shortlog.txton commit Merge branch 'jc/maint-do-not-switch-to-non-commit' (8ea6ae9)
   1git-shortlog(1)
   2===============
   3
   4NAME
   5----
   6git-shortlog - Summarize 'git-log' output
   7
   8SYNOPSIS
   9--------
  10[verse]
  11git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
  12git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
  13
  14DESCRIPTION
  15-----------
  16Summarizes 'git-log' output in a format suitable for inclusion
  17in release announcements. Each commit will be grouped by author and
  18the first line of the commit message will be shown.
  19
  20Additionally, "[PATCH]" will be stripped from the commit description.
  21
  22OPTIONS
  23-------
  24
  25-h::
  26--help::
  27        Print a short usage message and exit.
  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-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.
  47
  48FILES
  49-----
  50
  51If a file `.mailmap` exists at the toplevel of the repository,
  52it is used to map an author email address to a canonical real name. This
  53can be used to coalesce together commits by the same person where their
  54name was spelled differently (whether with the same email address or
  55not).
  56
  57Each line in the file consists, in this order, of the canonical real name
  58of an author, whitespace, and an email address (enclosed by '<' and '>')
  59to map to the name. Use hash '#' for comments, either on their own line,
  60or after the email address.
  61
  62A canonical name may appear in more than one line, associated with
  63different email addresses, but it doesn't make sense for a given address
  64to appear more than once (if that happens, a later line overrides the
  65earlier ones).
  66
  67So, for example, if your history contains commits by two authors, Jane
  68and Joe, whose names appear in the repository under several forms:
  69
  70------------
  71Joe Developer <joe@example.com>
  72Joe R. Developer <joe@example.com>
  73Jane Doe <jane@example.com>
  74Jane Doe <jane@laptop.(none)>
  75Jane D. <jane@desktop.(none)>
  76------------
  77
  78Then, supposing Joe wants his middle name initial used, and Jane prefers
  79her family name fully spelled out, a proper `.mailmap` file would look like:
  80
  81------------
  82# Note how we don't need an entry for <jane@laptop.(none)>, because the
  83# real name of that author is correct already, and coalesced directly.
  84Jane Doe <jane@desktop.(none)>
  85Joe R. Developer <joe@random.com>
  86------------
  87
  88Author
  89------
  90Written by Jeff Garzik <jgarzik@pobox.com>
  91
  92Documentation
  93--------------
  94Documentation by Junio C Hamano.
  95
  96GIT
  97---
  98Part of the linkgit:git[1] suite