Autogenerated HTML docs for v1.6.2-rc0-90-g0753

1 files changed, 64 insertions, 21 deletions

diff --git a/git-shortlog.html b/git-shortlog.html
index 2eb771250..832dd1e27 100644
--- a/git-shortlog.html
+++ b/git-shortlog.html
@@ -392,22 +392,42 @@ the first line of the commit message will be shown.</p></div>
 </dd>

 </dl></div>

 </div>

-<h2 id="_files">FILES</h2>

+<h2 id="_mapping_authors">MAPPING AUTHORS</h2>

 <div class="sectionbody">

-<div class="para"><p>If a file <tt>.mailmap</tt> exists at the toplevel of the repository,

-it is used to map an author email address to a canonical real name. This

-can be used to coalesce together commits by the same person where their

-name was spelled differently (whether with the same email address or

-not).</p></div>

-<div class="para"><p>Each line in the file consists, in this order, of the canonical real name

-of an author, whitespace, and an email address (enclosed by <em>&lt;</em> and <em>&gt;</em>)

-to map to the name. Use hash <em>#</em> for comments, either on their own line,

-or after the email address.</p></div>

-<div class="para"><p>A canonical name may appear in more than one line, associated with

-different email addresses, but it doesn't make sense for a given address

-to appear more than once (if that happens, a later line overrides the

-earlier ones).</p></div>

-<div class="para"><p>So, for example, if your history contains commits by two authors, Jane

+<div class="para"><p>The <tt>.mailmap</tt> feature is used to coalesce together commits by the same

+person in the shortlog, where their name and/or email address was

+spelled differently.</p></div>

+<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">

@@ -417,15 +437,38 @@ 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>Then, supposing 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="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># Note how we don't need an entry for &lt;jane@laptop.(none)&gt;, because the

-# real name of that author is correct already, and coalesced directly.

-Jane Doe &lt;jane@desktop.(none)&gt;

+<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="_author">Author</h2>

 <div class="sectionbody">

@@ -441,7 +484,7 @@ Joe R. Developer &lt;joe@example.com&gt;</tt></pre>
 </div>

 <div id="footer">

 <div id="footer-text">

-Last updated 2009-02-14 08:18:35 UTC

+Last updated 2009-02-15 10:37:55 UTC

 </div>

 </div>

 </body>