Documentation: begin discussion of git-remote in user manual
[git/jrn.git] / Documentation / git-shortlog.txt
blob95fa9010c1539e4c93d6d402ffd4bb670fd32910
1 git-shortlog(1)
2 ===============
4 NAME
5 ----
6 git-shortlog - Summarize 'git log' output
8 SYNOPSIS
9 --------
10 git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s]
11 git-shortlog [-n|--number] [-s|--summary] [<committish>...]
13 DESCRIPTION
14 -----------
15 Summarizes 'git log' output in a format suitable for inclusion
16 in release announcements. Each commit will be grouped by author and
17 the first line of the commit message will be shown.
19 Additionally, "[PATCH]" will be stripped from the commit description.
21 OPTIONS
22 -------
24 -h::
25         Print a short usage message and exit.
27 -n::
28         Sort output according to the number of commits per author instead
29         of author alphabetic order.
31 -s::
32         Supress commit description and provide a commit count summary only.
34 FILES
35 -----
36 '.mailmap'::
37         If this file exists, it will be used for mapping author email
38         addresses to a real author name. One mapping per line, first
39         the author name followed by the email address enclosed by
40         '<' and '>'. Use hash '#' for comments. Example:
42                 # Keep alphabetized
43                 Adam Morrow <adam@localhost.localdomain>
44                 Eve Jones <eve@laptop.(none)>
46 Author
47 ------
48 Written by Jeff Garzik <jgarzik@pobox.com>
50 Documentation
51 --------------
52 Documentation by Junio C Hamano.
54 GIT
55 ---
56 Part of the gitlink:git[7] suite