1
0
mirror of https://github.com/git/git.git synced 2024-11-19 05:03:55 +01:00
git/Documentation/git-check-mailmap.txt
Eric Sunshine 226ad3482a builtin: add git-check-mailmap command
Introduce command check-mailmap, similar to check-attr and check-ignore,
which allows direct testing of .mailmap configuration.

As plumbing accessible to scripts and other porcelain, check-mailmap
publishes the stable, well-tested .mailmap functionality employed by
built-in Git commands.  Consequently, script authors need not
re-implement .mailmap functionality manually, thus avoiding potential
quirks and behavioral differences.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-07-13 10:19:37 -07:00

48 lines
946 B
Plaintext

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>$$'' 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.
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.
MAPPING AUTHORS
---------------
include::mailmap.txt[]
GIT
---
Part of the linkgit:git[1] suite