diff options
Diffstat (limited to 'Documentation/git-shortlog.txt')
| -rw-r--r-- | Documentation/git-shortlog.txt | 44 |
1 files changed, 28 insertions, 16 deletions
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index b0df92e819..42463a955d 100644 --- a/Documentation/git-shortlog.txt +++ b/Documentation/git-shortlog.txt @@ -3,16 +3,17 @@ git-shortlog(1) NAME ---- -git-shortlog - Summarize 'git log' output +git-shortlog - Summarize 'git-log' output SYNOPSIS -------- -git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s] -git-shortlog [-n|--number] [-s|--summary] [<committish>...] +[verse] +git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w] +git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...] DESCRIPTION ----------- -Summarizes 'git log' output in a format suitable for inclusion +Summarizes 'git-log' output in a format suitable for inclusion in release announcements. Each commit will be grouped by author and the first line of the commit message will be shown. @@ -22,26 +23,38 @@ OPTIONS ------- -h:: +--help:: Print a short usage message and exit. -n:: +--numbered:: Sort output according to the number of commits per author instead of author alphabetic order. -s:: +--summary:: Suppress commit description and provide a commit count summary only. -FILES ------ -'.mailmap':: - If this file exists, it will be used for mapping author email - addresses to a real author name. One mapping per line, first - the author name followed by the email address enclosed by - '<' and '>'. Use hash '#' for comments. Example: +-e:: +--email:: + Show the email address of each author. + +-w[<width>[,<indent1>[,<indent2>]]]:: + Linewrap the output by wrapping each line at `width`. The first + line of each entry is indented by `indent1` spaces, and the second + and subsequent lines are indented by `indent2` spaces. `width`, + `indent1`, and `indent2` default to 76, 6 and 9 respectively. + + +MAPPING AUTHORS +--------------- + +The `.mailmap` feature is used to coalesce together commits by the same +person in the shortlog, where their name and/or email address was +spelled differently. + +include::mailmap.txt[] - # Keep alphabetized - Adam Morrow <adam@localhost.localdomain> - Eve Jones <eve@laptop.(none)> Author ------ @@ -53,5 +66,4 @@ Documentation by Junio C Hamano. GIT --- -Part of the gitlink:git[7] suite - +Part of the linkgit:git[1] suite |