diff options
Diffstat (limited to 'Documentation/git-check-mailmap.adoc')
| -rw-r--r-- | Documentation/git-check-mailmap.adoc | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/Documentation/git-check-mailmap.adoc b/Documentation/git-check-mailmap.adoc new file mode 100644 index 0000000000..966c91c46a --- /dev/null +++ b/Documentation/git-check-mailmap.adoc @@ -0,0 +1,64 @@ +git-check-mailmap(1) +==================== + +NAME +---- +git-check-mailmap - Show canonical names and email addresses of contacts + + +SYNOPSIS +-------- +[verse] +'git check-mailmap' [<options>] <contact>... + + +DESCRIPTION +----------- + +For each ``Name $$<user@host>$$'', ``$$<user@host>$$'', or ``$$user@host$$'' +from the command-line or standard input (when using `--stdin`), look up the +person's canonical name and email address (see "Mapping Authors" below). If +found, print them; otherwise print the input as-is. + + +OPTIONS +------- +--stdin:: + Read contacts, one per line, from the standard input after exhausting + contacts provided on the command-line. + +--mailmap-file=<file>:: + In addition to any configured mailmap files, read the specified + mailmap file. Entries in this file take precedence over entries in + either the default mailmap file or any configured mailmap file. + +--mailmap-blob=<blob>:: + Like `--mailmap-file`, but consider the value as a reference to a + blob in the repository. If both `--mailmap-file` and + `--mailmap-blob` are specified, entries in `--mailmap-file` will + take precedence. + +OUTPUT +------ + +For each contact, a single line is output, terminated by a newline. If the +name is provided or known to the 'mailmap', ``Name $$<user@host>$$'' is +printed; otherwise only ``$$<user@host>$$'' is printed. + + +CONFIGURATION +------------- + +See `mailmap.file` and `mailmap.blob` in linkgit:git-config[1] for how +to specify a custom `.mailmap` target file or object. + + +MAPPING AUTHORS +--------------- + +See linkgit:gitmailmap[5]. + + +GIT +--- +Part of the linkgit:git[1] suite |