66b6045849caba453202d4715c1538fddb742f3c
   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, or at the
  52location pointed to by the log.mailmap configuration option,
  53it is used to map an author email address to a canonical real name. This
  54can be used to coalesce together commits by the same person where their
  55name was spelled differently (whether with the same email address or
  56not).
  57
  58Each line in the file consists, in this order, of the canonical real name
  59of an author, whitespace, and an email address (enclosed by '<' and '>')
  60to map to the name. Use hash '#' for comments, either on their own line,
  61or after the email address.
  62
  63A canonical name may appear in more than one line, associated with
  64different email addresses, but it doesn't make sense for a given address
  65to appear more than once (if that happens, a later line overrides the
  66earlier ones).
  67
  68So, for example, if your history contains commits by two authors, Jane
  69and Joe, whose names appear in the repository under several forms:
  70
  71------------
  72Joe Developer <joe@example.com>
  73Joe R. Developer <joe@example.com>
  74Jane Doe <jane@example.com>
  75Jane Doe <jane@laptop.(none)>
  76Jane D. <jane@desktop.(none)>
  77------------
  78
  79Then, supposing Joe wants his middle name initial used, and Jane prefers
  80her family name fully spelled out, a proper `.mailmap` file would look like:
  81
  82------------
  83# Note how we don't need an entry for <jane@laptop.(none)>, because the
  84# real name of that author is correct already, and coalesced directly.
  85Jane Doe <jane@desktop.(none)>
  86Joe R. Developer <joe@example.com>
  87------------
  88
  89Author
  90------
  91Written by Jeff Garzik <jgarzik@pobox.com>
  92
  93Documentation
  94--------------
  95Documentation by Junio C Hamano.
  96
  97GIT
  98---
  99Part of the linkgit:git[1] suite