mirror of
https://github.com/git/git
synced 2024-08-28 12:09:19 +00:00
![Jeff King](/assets/img/avatar_default.png)
When trying to find a .mailmap file, we will always look for it in the current directory. This makes sense in a repository with a working tree, since we'd always go to the toplevel directory at startup. But for a bare repository, it can be confusing. With an option like --git-dir (or $GIT_DIR in the environment), we don't chdir at all, and we'd read .mailmap from whatever directory you happened to be in before starting Git. (Note that --git-dir without specifying a working tree historically means "the current directory is the root of the working tree", but most bare repositories will have core.bare set these days, meaning they will realize there is no working tree at all). The documentation for gitmailmap(5) says: If the file `.mailmap` exists at the toplevel of the repository[...] which likewise reinforces the notion that we are looking in the working tree. This patch prevents us from looking for such a file when we're in a bare repository. This does break something that used to work: cd bare.git git cat-file blob HEAD:.mailmap >.mailmap git shortlog But that was never advertised in the documentation. And these days we have mailmap.blob (which defaults to HEAD:.mailmap) to do the same thing in a much cleaner way. However, there's one more interesting case: we might not have a repository at all! The git-shortlog command can be run with git-log output fed on its stdin, and it will apply the mailmap. In that case, it probably does make sense to read .mailmap from the current directory. This patch will continue to do so. That leads to one even weirder case: if you run git-shortlog to process stdin, the input _could_ be from a different repository entirely. Should we respect the in-tree .mailmap then? Probably yes. Whatever the source of the input, if shortlog is running in a repository, the documentation claims that we'd read the .mailmap from its top-level (and of course it's reasonably likely that it _is_ from the same repo, and the user just preferred to run git-log and git-shortlog separately for whatever reason). The included test covers these cases, and we now document the "no repo" case explicitly. We also add a test that confirms we find a top-level ".mailmap" even when we start in a subdirectory of the working tree. This worked both before and after this commit, but we never tested it explicitly (it works because we always chdir to the top-level of the working tree if there is one). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
123 lines
4 KiB
Plaintext
123 lines
4 KiB
Plaintext
git-shortlog(1)
|
|
===============
|
|
|
|
NAME
|
|
----
|
|
git-shortlog - Summarize 'git log' output
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git shortlog' [<options>] [<revision range>] [[--] <path>...]
|
|
git log --pretty=short | 'git shortlog' [<options>]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Summarizes 'git log' output in a format suitable for inclusion
|
|
in 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 input
|
|
is not a terminal or there is no current branch, 'git shortlog' will
|
|
output a summary of the log read from standard input, without
|
|
reference to the current repository.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
-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.
|
|
|
|
-e::
|
|
--email::
|
|
Show the email address of each author.
|
|
|
|
--format[=<format>]::
|
|
Instead of the commit subject, use some other information to
|
|
describe each commit. '<format>' can be any string accepted
|
|
by the `--format` option of 'git log', such as '* [%h] %s'.
|
|
(See the "PRETTY FORMATS" section of linkgit:git-log[1].)
|
|
|
|
Each pretty-printed commit will be rewrapped before it is shown.
|
|
|
|
--group=<type>::
|
|
Group commits based on `<type>`. If no `--group` option is
|
|
specified, the default is `author`. `<type>` is one of:
|
|
+
|
|
--
|
|
- `author`, commits are grouped by author
|
|
- `committer`, commits are grouped by committer (the same as `-c`)
|
|
- `trailer:<field>`, the `<field>` is interpreted as a case-insensitive
|
|
commit message trailer (see linkgit:git-interpret-trailers[1]). For
|
|
example, if your project uses `Reviewed-by` trailers, you might want
|
|
to see who has been reviewing with
|
|
`git shortlog -ns --group=trailer:reviewed-by`.
|
|
+
|
|
Note that commits that do not include the trailer will not be counted.
|
|
Likewise, commits with multiple trailers (e.g., multiple signoffs) may
|
|
be counted more than once (but only once per unique trailer value in
|
|
that commit).
|
|
+
|
|
Shortlog will attempt to parse each trailer value as a `name <email>`
|
|
identity. If successful, the mailmap is applied and the email is omitted
|
|
unless the `--email` option is specified. If the value cannot be parsed
|
|
as an identity, it will be taken literally and completely.
|
|
--
|
|
+
|
|
If `--group` is specified multiple times, commits are counted under each
|
|
value (but again, only once per unique value in that commit). For
|
|
example, `git shortlog --group=author --group=trailer:co-authored-by`
|
|
counts both authors and co-authors.
|
|
|
|
-c::
|
|
--committer::
|
|
This is an alias for `--group=committer`.
|
|
|
|
-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.
|
|
+
|
|
If width is `0` (zero) then indent the lines of the output without wrapping
|
|
them.
|
|
|
|
<revision range>::
|
|
Show only commits in the specified revision range. When no
|
|
<revision range> is specified, it defaults to `HEAD` (i.e. the
|
|
whole history leading to the current commit). `origin..HEAD`
|
|
specifies all the commits reachable from the current commit
|
|
(i.e. `HEAD`), but not from `origin`. For a complete list of
|
|
ways to spell <revision range>, see the "Specifying Ranges"
|
|
section of linkgit:gitrevisions[7].
|
|
|
|
[--] <path>...::
|
|
Consider only commits that are enough to explain how the files
|
|
that match the specified paths came to be.
|
|
+
|
|
Paths may need to be prefixed with `--` to separate them from
|
|
options or the revision range, when confusion arises.
|
|
|
|
:git-shortlog: 1
|
|
include::rev-list-options.txt[]
|
|
|
|
MAPPING AUTHORS
|
|
---------------
|
|
|
|
See linkgit:gitmailmap[5].
|
|
|
|
Note that if `git shortlog` is run outside of a repository (to process
|
|
log contents on standard input), it will look for a `.mailmap` file in
|
|
the current directory.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|