From 7d48e9e6f77d336376c1a554eeff0590f77e1ee1 Mon Sep 17 00:00:00 2001 From: Marius Storm-Olsen Date: Sun, 8 Feb 2009 15:34:31 +0100 Subject: Move mailmap documentation into separate file Include it directly from git-shortlog.txt, and refer to it from pretty-format.txt. Signed-off-by: Marius Storm-Olsen Signed-off-by: Junio C Hamano --- Documentation/mailmap.txt | 75 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 Documentation/mailmap.txt (limited to 'Documentation/mailmap.txt') diff --git a/Documentation/mailmap.txt b/Documentation/mailmap.txt new file mode 100644 index 0000000000..e25b154838 --- /dev/null +++ b/Documentation/mailmap.txt @@ -0,0 +1,75 @@ +If the file `.mailmap` exists at the toplevel of the repository, or at +the location pointed to by the mailmap.file configuration option, it +is used to map author and committer names and email addresses to +canonical real names and email addresses. + +In the simple form, each line in the file consists of the canonical +real name of an author, whitespace, and an email address used in the +commit (enclosed by '<' and '>') to map to the name. Thus, looks like +this +-- + Proper Name +-- + +The more complex forms are +-- + +-- +which allows mailmap to replace only the email part of a commit, and +-- + Proper Name +-- +which allows mailmap to replace both the name and the email of a +commit matching the specified commit email address, and +-- + Proper Name Commit Name +-- +which allows mailmap to replace both the name and the email of a +commit matching both the specified commit name and email address. + +Example 1: Your history contains commits by two authors, Jane +and Joe, whose names appear in the repository under several forms: + +------------ +Joe Developer +Joe R. Developer +Jane Doe +Jane Doe +Jane D. +------------ + +Now suppose that Joe wants his middle name initial used, and Jane +prefers her family name fully spelled out. A proper `.mailmap` file +would look like: + +------------ +Jane Doe +Joe R. Developer +------------ + +Note how we don't need an entry for , because the +real name of that author is correct already. + +Example 2: Your repository contains commits from the following +authors: + +------------ +nick1 +nick2 +nick2 +santa +claus +CTO +------------ + +Then, you might want a `.mailmap` file looking like: +------------ + +Some Dude nick1 +Other Author nick2 +Other Author +Santa Claus +------------ + +Use hash '#' for comments that are either on their own line, or after +the email address. \ No newline at end of file -- cgit v1.2.3 From b89510f024d228ad1c2f0fb4752157c18cc10d82 Mon Sep 17 00:00:00 2001 From: "David J. Mellor" Date: Mon, 16 Mar 2009 23:16:16 -0700 Subject: Documentation: minor grammatical fixes in git-blame.txt. Signed-off-by: David J. Mellor Signed-off-by: Junio C Hamano --- Documentation/mailmap.txt | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) (limited to 'Documentation/mailmap.txt') diff --git a/Documentation/mailmap.txt b/Documentation/mailmap.txt index e25b154838..288f04e70c 100644 --- a/Documentation/mailmap.txt +++ b/Documentation/mailmap.txt @@ -5,22 +5,21 @@ canonical real names and email addresses. In the simple form, each line in the file consists of the canonical real name of an author, whitespace, and an email address used in the -commit (enclosed by '<' and '>') to map to the name. Thus, looks like -this +commit (enclosed by '<' and '>') to map to the name. For example: -- Proper Name -- -The more complex forms are +The more complex forms are: -- -- -which allows mailmap to replace only the email part of a commit, and +which allows mailmap to replace only the email part of a commit, and: -- Proper Name -- which allows mailmap to replace both the name and the email of a -commit matching the specified commit email address, and +commit matching the specified commit email address, and: -- Proper Name Commit Name -- @@ -47,8 +46,8 @@ Jane Doe Joe R. Developer ------------ -Note how we don't need an entry for , because the -real name of that author is correct already. +Note how there is no need for an entry for , because the +real name of that author is already correct. Example 2: Your repository contains commits from the following authors: @@ -62,7 +61,7 @@ claus CTO ------------ -Then, you might want a `.mailmap` file looking like: +Then you might want a `.mailmap` file that looks like: ------------ Some Dude nick1 @@ -72,4 +71,4 @@ Santa Claus ------------ Use hash '#' for comments that are either on their own line, or after -the email address. \ No newline at end of file +the email address. -- cgit v1.2.3