projects / thirdparty / git.git / blame
| Commit | Line | Data |
|---|---|---|
| 3f971fc4 JH |
1 | git-shortlog(1) |
| 2 | =============== | |
| 3f971fc4 JH |
3 | |
| 4 | NAME | |
| 5 | ---- | |
| 0b444cdb | 6 | git-shortlog - Summarize 'git log' output |
| 3f971fc4 | 7 | |
| 3f971fc4 JH |
8 | SYNOPSIS |
| 9 | -------- | |
| 0ad64fd0 | 10 | [verse] |
| b1889c36 | 11 | git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w] |
| 02646fe5 | 12 | 'git shortlog' [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] <commit>... |
| 3f971fc4 JH |
13 | |
| 14 | DESCRIPTION | |
| 15 | ----------- | |
| 0b444cdb | 16 | Summarizes 'git log' output in a format suitable for inclusion |
| 4e27fb06 | 17 | in release announcements. Each commit will be grouped by author and |
| 74237d62 JF |
18 | the first line of the commit message will be shown. |
| 19 | ||
| 20 | Additionally, "[PATCH]" will be stripped from the commit description. | |
| 21 | ||
| 02646fe5 JN |
22 | If no revisions are passed on the command line and either standard input |
| 23 | is not a terminal or there is no current branch, 'git shortlog' will | |
| 24 | output a summary of the log read from standard input, without | |
| 25 | reference to the current repository. | |
| 26 | ||
| 4e27fb06 NP |
27 | OPTIONS |
| 28 | ------- | |
| 29 | ||
| 3240240f SB |
30 | -h:: |
| 31 | --help:: | |
| 4e27fb06 NP |
32 | Print a short usage message and exit. |
| 33 | ||
| 3240240f SB |
34 | -n:: |
| 35 | --numbered:: | |
| 4e27fb06 NP |
36 | Sort output according to the number of commits per author instead |
| 37 | of author alphabetic order. | |
| 38 | ||
| 3240240f SB |
39 | -s:: |
| 40 | --summary:: | |
| 23bfbb81 | 41 | Suppress commit description and provide a commit count summary only. |
| 4e27fb06 | 42 | |
| 3240240f SB |
43 | -e:: |
| 44 | --email:: | |
| 6508bb75 JK |
45 | Show the email address of each author. |
| 46 | ||
| efc39d6d | 47 | --format[=<format>]:: |
| 60037249 JN |
48 | Instead of the commit subject, use some other information to |
| 49 | describe each commit. '<format>' can be any string accepted | |
| 50 | by the `--format` option of 'git log', such as '{asterisk} [%h] %s'. | |
| 51 | (See the "PRETTY FORMATS" section of linkgit:git-log[1].) | |
| 52 | ||
| 53 | Each pretty-printed commit will be rewrapped before it is shown. | |
| 54 | ||
| 55ef8a46 JH |
55 | -w[<width>[,<indent1>[,<indent2>]]]:: |
| 56 | Linewrap the output by wrapping each line at `width`. The first | |
| 57 | line of each entry is indented by `indent1` spaces, and the second | |
| 58 | and subsequent lines are indented by `indent2` spaces. `width`, | |
| 59 | `indent1`, and `indent2` default to 76, 6 and 9 respectively. | |
| 60 | ||
| 7d48e9e6 MSO |
61 | |
| 62 | MAPPING AUTHORS | |
| 63 | --------------- | |
| 64 | ||
| 65 | The `.mailmap` feature is used to coalesce together commits by the same | |
| 66 | person in the shortlog, where their name and/or email address was | |
| 67 | spelled differently. | |
| 68 | ||
| 69 | include::mailmap.txt[] | |
| 0925ce4d | 70 | |
| 3f971fc4 JH |
71 | GIT |
| 72 | --- | |
| 9e1f0a85 | 73 | Part of the linkgit:git[1] suite |