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>]]]] <commit>...
  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 -h::
  30 --help::
  31         Print a short usage message and exit.
  32
  33 -n::
  34 --numbered::
  35         Sort output according to the number of commits per author instead
  36         of author alphabetic order.
  37
  38 -s::
  39 --summary::
  40         Suppress commit description and provide a commit count summary only.
  41
  42 -e::
  43 --email::
  44         Show the email address of each author.
  45
  46 --format[=<format>]::
  47         Instead of the commit subject, use some other information to
  48         describe each commit.  '<format>' can be any string accepted
  49         by the `--format` option of 'git log', such as '* [%h] %s'.
  50         (See the "PRETTY FORMATS" section of linkgit:git-log[1].)
  51
  52         Each pretty-printed commit will be rewrapped before it is shown.
  53
  54 -w[<width>[,<indent1>[,<indent2>]]]::
  55         Linewrap the output by wrapping each line at `width`.  The first
  56         line of each entry is indented by `indent1` spaces, and the second
  57         and subsequent lines are indented by `indent2` spaces. `width`,
  58         `indent1`, and `indent2` default to 76, 6 and 9 respectively.
  59 +
  60 If width is `0` (zero) then indent the lines of the output without wrapping
  61 them.
  62
  63
  64 MAPPING AUTHORS
  65 ---------------
  66
  67 The `.mailmap` feature is used to coalesce together commits by the same
  68 person in the shortlog, where their name and/or email address was
  69 spelled differently.
  70
  71 include::mailmap.txt[]
  72
  73 GIT
  74 ---
  75 Part of the linkgit:git[1] suite