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-log --pretty=short | 'git-shortlog' [-h] [-n] [-s] [-e] [-w]
  12 git-shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
  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
  18 the first line of the commit message will be shown.
  19
  20 Additionally, "[PATCH]" will be stripped from the commit description.
  21
  22 OPTIONS
  23 -------
  24
  25 -h, \--help::
  26         Print a short usage message and exit.
  27
  28 -n, \--numbered::
  29         Sort output according to the number of commits per author instead
  30         of author alphabetic order.
  31
  32 -s, \--summary::
  33         Suppress commit description and provide a commit count summary only.
  34
  35 -e, \--email::
  36         Show the email address of each author.
  37
  38 -w[<width>[,<indent1>[,<indent2>]]]::
  39         Linewrap the output by wrapping each line at `width`.  The first
  40         line of each entry is indented by `indent1` spaces, and the second
  41         and subsequent lines are indented by `indent2` spaces. `width`,
  42         `indent1`, and `indent2` default to 76, 6 and 9 respectively.
  43
  44 FILES
  45 -----
  46
  47 If the file `.mailmap` exists, it will be used for mapping author
  48 email addresses to a real author name. One mapping per line, first
  49 the author name followed by the email address enclosed by
  50 '<' and '>'. Use hash '#' for comments. Example:
  51
  52 ------------
  53 # Keep alphabetized
  54 Adam Morrow <adam@localhost.localdomain>
  55 Eve Jones <eve@laptop.(none)>
  56 ------------
  57
  58 Author
  59 ------
  60 Written by Jeff Garzik <jgarzik@pobox.com>
  61
  62 Documentation
  63 --------------
  64 Documentation by Junio C Hamano.
  65
  66 GIT
  67 ---
  68 Part of the linkgit:git[7] suite