Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 1 | git-shortlog(1) |
| 2 | =============== |
| 3 | |
| 4 | NAME |
| 5 | ---- |
Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 6 | git-shortlog - Summarize 'git log' output |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 7 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 8 | SYNOPSIS |
| 9 | -------- |
Junio C Hamano | b6bd6ce | 2007-04-18 23:54:28 | [diff] [blame] | 10 | [verse] |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 11 | git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w] |
Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 12 | 'git shortlog' [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] <commit>... |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 13 | |
| 14 | DESCRIPTION |
| 15 | ----------- |
Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 16 | Summarizes 'git log' output in a format suitable for inclusion |
Junio C Hamano | 281fd39 | 2012-09-17 23:57:41 | [diff] [blame] | 17 | in release announcements. Each commit will be grouped by author and title. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 18 | |
Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 19 | Additionally, "[PATCH]" will be stripped from the commit description. |
| 20 | |
Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 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 | |
Junio C Hamano | 5f1dfc7 | 2006-10-10 04:36:30 | [diff] [blame] | 26 | OPTIONS |
| 27 | ------- |
| 28 | |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 29 | -h:: |
| 30 | --help:: |
Junio C Hamano | 5f1dfc7 | 2006-10-10 04:36:30 | [diff] [blame] | 31 | Print a short usage message and exit. |
| 32 | |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 33 | -n:: |
| 34 | --numbered:: |
Junio C Hamano | 5f1dfc7 | 2006-10-10 04:36:30 | [diff] [blame] | 35 | Sort output according to the number of commits per author instead |
| 36 | of author alphabetic order. |
| 37 | |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 38 | -s:: |
| 39 | --summary:: |
Junio C Hamano | f9771f6 | 2007-01-17 17:42:30 | [diff] [blame] | 40 | Suppress commit description and provide a commit count summary only. |
Junio C Hamano | 5f1dfc7 | 2006-10-10 04:36:30 | [diff] [blame] | 41 | |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 42 | -e:: |
| 43 | --email:: |
Junio C Hamano | 0c0da5f | 2007-12-13 02:45:30 | [diff] [blame] | 44 | Show the email address of each author. |
| 45 | |
Junio C Hamano | d2179ef | 2010-10-22 04:12:17 | [diff] [blame] | 46 | --format[=<format>]:: |
Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 47 | Instead of the commit subject, use some other information to |
| 48 | describe each commit. '<format>' can be any string accepted |
Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 49 | by the `--format` option of 'git log', such as '* [%h] %s'. |
Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 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 | |
Junio C Hamano | 1bdd3b0 | 2008-04-13 05:33:18 | [diff] [blame] | 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 | |
Junio C Hamano | b6bd6ce | 2007-04-18 23:54:28 | [diff] [blame] | 60 | |
Junio C Hamano | 8bc410e | 2009-02-15 10:38:19 | [diff] [blame] | 61 | MAPPING AUTHORS |
| 62 | --------------- |
Junio C Hamano | 2fa431b | 2008-12-28 01:26:23 | [diff] [blame] | 63 | |
Junio C Hamano | 8bc410e | 2009-02-15 10:38:19 | [diff] [blame] | 64 | The `.mailmap` feature is used to coalesce together commits by the same |
| 65 | person in the shortlog, where their name and/or email address was |
| 66 | spelled differently. |
Junio C Hamano | 2fa431b | 2008-12-28 01:26:23 | [diff] [blame] | 67 | |
Junio C Hamano | 8bc410e | 2009-02-15 10:38:19 | [diff] [blame] | 68 | include::mailmap.txt[] |
Junio C Hamano | 2fa431b | 2008-12-28 01:26:23 | [diff] [blame] | 69 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 70 | GIT |
| 71 | --- |
Junio C Hamano | f7c042d | 2008-06-06 22:50:53 | [diff] [blame] | 72 | Part of the linkgit:git[1] suite |