summaryrefslogtreecommitdiffstats
path: root/git-blame.html
diff options
context:
space:
mode:
authorJunio C Hamano <junio@hera.kernel.org>2009-02-15 10:38:19 +0000
committerJunio C Hamano <junio@hera.kernel.org>2009-02-15 10:38:19 +0000
commit8bc410e7932f0c634f6c651114755bfcb7dc0fb2 (patch)
tree2d04caab33cefb1472dfc97498ff4a4d443aeb9c /git-blame.html
parenta5ec842daf494e5b4141432e38cd2044ebbac61e (diff)
downloadgit-htmldocs-8bc410e7932f0c634f6c651114755bfcb7dc0fb2.tar.gz
Autogenerated HTML docs for v1.6.2-rc0-90-g0753
Diffstat (limited to 'git-blame.html')
-rw-r--r--git-blame.html77
1 files changed, 76 insertions, 1 deletions
diff --git a/git-blame.html b/git-blame.html
index b8b0237dc..8cc87263b 100644
--- a/git-blame.html
+++ b/git-blame.html
@@ -744,6 +744,81 @@ commit commentary), a blame viewer won't ever care.</td>
</li>
</ol></div>
</div>
+<h2 id="_mapping_authors">MAPPING AUTHORS</h2>
+<div class="sectionbody">
+<div class="para"><p>If the file <tt>.mailmap</tt> 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.</p></div>
+<div class="para"><p>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 <em>&lt;</em> and <em>&gt;</em>) to map to the name. Thus, looks like
+this</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>Proper Name &lt;commit@email.xx&gt;</tt></pre>
+</div></div>
+<div class="para"><p>The more complex forms are</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>&lt;proper@email.xx&gt; &lt;commit@email.xx&gt;</tt></pre>
+</div></div>
+<div class="para"><p>which allows mailmap to replace only the email part of a commit, and</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>Proper Name &lt;proper@email.xx&gt; &lt;commit@email.xx&gt;</tt></pre>
+</div></div>
+<div class="para"><p>which allows mailmap to replace both the name and the email of a
+commit matching the specified commit email address, and</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><tt>Proper Name &lt;proper@email.xx&gt; Commit Name &lt;commit@email.xx&gt;</tt></pre>
+</div></div>
+<div class="para"><p>which allows mailmap to replace both the name and the email of a
+commit matching both the specified commit name and email address.</p></div>
+<div class="para"><p>Example 1: Your history contains commits by two authors, Jane
+and Joe, whose names appear in the repository under several forms:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>Joe Developer &lt;joe@example.com&gt;
+Joe R. Developer &lt;joe@example.com&gt;
+Jane Doe &lt;jane@example.com&gt;
+Jane Doe &lt;jane@laptop.(none)&gt;
+Jane D. &lt;jane@desktop.(none)&gt;</tt></pre>
+</div></div>
+<div class="para"><p>Now suppose that Joe wants his middle name initial used, and Jane
+prefers her family name fully spelled out. A proper <tt>.mailmap</tt> file
+would look like:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>Jane Doe &lt;jane@desktop.(none)&gt;
+Joe R. Developer &lt;joe@example.com&gt;</tt></pre>
+</div></div>
+<div class="para"><p>Note how we don't need an entry for &lt;jane@laptop.(none)&gt;, because the
+real name of that author is correct already.</p></div>
+<div class="para"><p>Example 2: Your repository contains commits from the following
+authors:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>nick1 &lt;bugs@company.xx&gt;
+nick2 &lt;bugs@company.xx&gt;
+nick2 &lt;nick2@company.xx&gt;
+santa &lt;me@company.xx&gt;
+claus &lt;me@company.xx&gt;
+CTO &lt;cto@coompany.xx&gt;</tt></pre>
+</div></div>
+<div class="para"><p>Then, you might want a <tt>.mailmap</tt> file looking like:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>&lt;cto@company.xx&gt; &lt;cto@coompany.xx&gt;
+Some Dude &lt;some@dude.xx&gt; nick1 &lt;bugs@company.xx&gt;
+Other Author &lt;other@author.xx&gt; nick2 &lt;bugs@company.xx&gt;
+Other Author &lt;other@author.xx&gt; &lt;nick2@company.xx&gt;
+Santa Claus &lt;santa.claus@northpole.xx&gt; &lt;me@company.xx&gt;</tt></pre>
+</div></div>
+<div class="para"><p>Use hash <em>#</em> for comments that are either on their own line, or after
+the email address.</p></div>
+</div>
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="para"><p><a href="git-annotate.html">git-annotate(1)</a></p></div>
@@ -758,7 +833,7 @@ commit commentary), a blame viewer won't ever care.</td>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2009-02-14 08:18:03 UTC
+Last updated 2009-02-15 10:37:52 UTC
</div>
</div>
</body>