NAME

git-shortlog - Summarize git log output

SYNOPSIS

  1. git shortlog [<options>] [<revision range>] [[--] <path>…​]
  2. git log --pretty=short | git shortlog [<options>]

DESCRIPTION

Summarizes git log output in a format suitable for inclusionin release announcements. Each commit will be grouped by author and title.

Additionally, "[PATCH]" will be stripped from the commit description.

If no revisions are passed on the command line and either standard inputis not a terminal or there is no current branch, git shortlog willoutput a summary of the log read from standard input, withoutreference to the current repository.

OPTIONS

  • -n
  • —numbered

  • Sort output according to the number of commits per author insteadof author alphabetic order.

  • -s

  • —summary

  • Suppress commit description and provide a commit count summary only.

  • -e

  • —email

  • Show the email address of each author.

  • —format[=]

  • Instead of the commit subject, use some other information todescribe each commit. can be any string acceptedby the —format option of git log, such as * [%h] %s.(See the "PRETTY FORMATS" section of git-log[1].)
  1. Each pretty-printed commit will be rewrapped before it is shown.
  • -c
  • —committer

  • Collect and show committer identities instead of authors.

  • -w[[,[,]]]

  • Linewrap the output by wrapping each line at width. The firstline of each entry is indented by indent1 spaces, and the secondand subsequent lines are indented by indent2 spaces. width,indent1, and indent2 default to 76, 6 and 9 respectively.

If width is 0 (zero) then indent the lines of the output without wrappingthem.

  • Show only commits in the specified revision range. When no is specified, it defaults to HEAD (i.e. thewhole history leading to the current commit). origin..HEADspecifies all the commits reachable from the current commit(i.e. HEAD), but not from origin. For a complete list ofways to spell , see the "Specifying Ranges"section of gitrevisions[7].

  • [—] …​

  • Consider only commits that are enough to explain how the filesthat match the specified paths came to be.

Paths may need to be prefixed with — to separate them fromoptions or the revision range, when confusion arises.

MAPPING AUTHORS

The .mailmap feature is used to coalesce together commits by the sameperson in the shortlog, where their name and/or email address wasspelled differently.

If the file .mailmap exists at the toplevel of the repository, or atthe location pointed to by the mailmap.file or mailmap.blobconfiguration options, itis used to map author and committer names and email addresses tocanonical real names and email addresses.

In the simple form, each line in the file consists of the canonicalreal name of an author, whitespace, and an email address used in thecommit (enclosed by < and >) to map to the name. For example:

  1. Proper Name <commit@email.xx>

The more complex forms are:

  1. <proper@email.xx> <commit@email.xx>

which allows mailmap to replace only the email part of a commit, and:

  1. Proper Name <proper@email.xx> <commit@email.xx>

which allows mailmap to replace both the name and the email of acommit matching the specified commit email address, and:

  1. Proper Name <proper@email.xx> Commit Name <commit@email.xx>

which allows mailmap to replace both the name and the email of acommit matching both the specified commit name and email address.

Example 1: Your history contains commits by two authors, Janeand Joe, whose names appear in the repository under several forms:

  1. Joe Developer <joe@example.com>
  2. Joe R. Developer <joe@example.com>
  3. Jane Doe <jane@example.com>
  4. Jane Doe <jane@laptop.(none)>
  5. Jane D. <jane@desktop.(none)>

Now suppose that Joe wants his middle name initial used, and Janeprefers her family name fully spelled out. A proper .mailmap filewould look like:

  1. Jane Doe         <jane@desktop.(none)>
  2. Joe R. Developer <joe@example.com>

Note how there is no need for an entry for <jane@laptop.(none)>, because thereal name of that author is already correct.

Example 2: Your repository contains commits from the followingauthors:

  1. nick1 <bugs@company.xx>
  2. nick2 <bugs@company.xx>
  3. nick2 <nick2@company.xx>
  4. santa <me@company.xx>
  5. claus <me@company.xx>
  6. CTO <cto@coompany.xx>

Then you might want a .mailmap file that looks like:

  1. <cto@company.xx>                       <cto@coompany.xx>
  2. Some Dude <some@dude.xx>         nick1 <bugs@company.xx>
  3. Other Author <other@author.xx>   nick2 <bugs@company.xx>
  4. Other Author <other@author.xx>         <nick2@company.xx>
  5. Santa Claus <santa.claus@northpole.xx> <me@company.xx>

Use hash # for comments that are either on their own line, or afterthe email address.

GIT

Part of the git[1] suite