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>]]]] [(-K|--sort-key-regexp) <regexp>] [(-k|--sort-key) <n>] [<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::
  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
  48 -K <regexp>::
  49 --sort-key-regexp <regexp>::
  50         Instead of sorting by author, sort by a regular expression on the
  51         commit subject (or whatever you specified using --pretty)
  52
  53 -k <number>::
  54 --sort-key <number>::
  55         Instead of sorting by author, sort by a given whitespace-delimited
  56         field of the commit subject (or whatever you specified using
  57         --pretty).  The first field is 1.
  58
  59
  60 MAPPING AUTHORS
  61 ---------------
  62
  63 The `.mailmap` feature is used to coalesce together commits by the same
  64 person in the shortlog, where their name and/or email address was
  65 spelled differently.
  66
  67 include::mailmap.txt[]
  68
  69
  70 Author
  71 ------
  72 Written by Jeff Garzik <jgarzik@pobox.com>
  73
  74 Documentation
  75 --------------
  76 Documentation by Junio C Hamano.
  77
  78 GIT
  79 ---
  80 Part of the linkgit:git[1] suite