path: root/Documentation/git-check-mailmap.txt
diff options
authorEric Sunshine <>2013-07-13 00:53:10 (GMT)
committerJunio C Hamano <>2013-07-13 17:19:37 (GMT)
commit226ad3482ac506af0eadd04e732dda556fda80e4 (patch)
tree2d40f98d860da3c59192670ca99203e824abb2d4 /Documentation/git-check-mailmap.txt
parent7a3187eb788854ed3a20fee30b27e68430f753b7 (diff)
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 <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-check-mailmap.txt')
1 files changed, 47 insertions, 0 deletions
diff --git a/Documentation/git-check-mailmap.txt b/Documentation/git-check-mailmap.txt
new file mode 100644
index 0000000..39028ee
--- /dev/null
+++ b/Documentation/git-check-mailmap.txt
@@ -0,0 +1,47 @@
+git-check-mailmap - Show canonical names and email addresses of contacts
+'git check-mailmap' [options] <contact>...
+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.
+ Read contacts, one per line, from the standard input after exhausting
+ contacts provided on the command-line.
+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.
+Part of the linkgit:git[1] suite