Index: docs/html/git-upstream-diff.html |
diff --git a/docs/html/git-map-branches.html b/docs/html/git-upstream-diff.html |
similarity index 84% |
copy from docs/html/git-map-branches.html |
copy to docs/html/git-upstream-diff.html |
index e6d160c7e2425897b46226dc26e17e2848f4991b..d4aa4c6c1798bda311d4641c794b32e13267dc48 100644 |
--- a/docs/html/git-map-branches.html |
+++ b/docs/html/git-upstream-diff.html |
@@ -4,7 +4,7 @@ |
<head> |
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> |
<meta name="generator" content="AsciiDoc 8.6.9" /> |
-<title>git-map-branches(1)</title> |
+<title>git-upstream-diff(1)</title> |
<style type="text/css"> |
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ |
@@ -741,12 +741,12 @@ asciidoc.install(); |
<body class="manpage"> |
<div id="header"> |
<h1> |
-git-map-branches(1) Manual Page |
+git-upstream-diff(1) Manual Page |
</h1> |
<h2>NAME</h2> |
<div class="sectionbody"> |
-<p>git-map-branches - |
- Helper script to display all local git branches with ‘upstream’ hierarchy in colorized terminal format. |
+<p>git-upstream-diff - |
+ Print a diff of the current branch, compared to its upstream. |
</p> |
</div> |
</div> |
@@ -755,7 +755,7 @@ git-map-branches(1) Manual Page |
<h2 id="_synopsis">SYNOPSIS</h2> |
<div class="sectionbody"> |
<div class="verseblock"> |
-<pre class="content"><em>git map-branches</em></pre> |
+<pre class="content"><em>git upstream-diff</em> [--wordwise] [<extra args for git-diff>*]</pre> |
<div class="attribution"> |
</div></div> |
</div> |
@@ -763,80 +763,109 @@ git-map-branches(1) Manual Page |
<div class="sect1"> |
<h2 id="_description">DESCRIPTION</h2> |
<div class="sectionbody"> |
-<div class="paragraph"><p>Git map-branches displays all local branches such that:</p></div> |
-<div class="ulist"><ul> |
+<div class="paragraph"><p>Shows a diff beween your current branch and it’s upstream. This is <em>roughly</em> the |
+same as:</p></div> |
+<div class="listingblock"> |
+<div class="content"> |
+<pre><code>git diff --patience -C -C HEAD@{upstream} <b><1></b> <b><2></b></code></pre> |
+</div></div> |
+<div class="colist arabic"><ol> |
<li> |
<p> |
-Current branch is <span class="aqua">cyan</span>. |
+<code>-C -C</code> detects file copies/renames |
</p> |
-<div class="ulist"><ul> |
+</li> |
<li> |
<p> |
-The branch which will be modified with git-commit is denoted with an asterisk |
- (<code>*</code>) after the name. |
+<code>--patience</code> uses the patience-diff algorithm, which tends to produce nicer |
+ diffs in many cases. |
</p> |
</li> |
-</ul></div> |
-</li> |
-<li> |
+</ol></div> |
+<div class="paragraph"><p>The difference is that <code>HEAD@{upstream}</code> is actually the tagged merge base of |
+your branch (See <a href="git-rebase-update.html">git-rebase-update(1)</a>). This means that if your upstream |
+branch was rebased, but you haven’t yet rebased the current branch on top of it, |
+you’ll still see an accurate diff compared to just diffing against |
+<code>@{upstream}</code>.</p></div> |
+<div class="paragraph"><p>The <code>--wordwise</code> option also allows <code>git-diff</code> to do word-by-word comparison |
+in a semi-intelligent way. However, sometimes it can produce surprising results, |
+so it is disabled by default.</p></div> |
+</div> |
+</div> |
+<div class="sect1"> |
+<h2 id="_options">OPTIONS</h2> |
+<div class="sectionbody"> |
+<div class="dlist"><dl> |
+<dt class="hdlist1"> |
+--wordwise |
+</dt> |
+<dd> |
<p> |
-Local branches are <span class="green">green</span>. |
+ Print a colorized word-wise diff instead of a line-wise diff. |
</p> |
-</li> |
-<li> |
+</dd> |
+<dt class="hdlist1"> |
+<extra args for git-diff> |
+</dt> |
+<dd> |
<p> |
-Remote branches are <span class="red">red</span> (usually, the root of all other branches). |
+ Extra arguments are included in the invocation of <a href="git-diff.html">git-diff(1)</a>. These |
+ can be anything that <code>git-diff</code> normally takes. |
</p> |
-</li> |
-<li> |
+<div class="openblock"> |
+<div class="content"> |
+<div class="dlist"><dl> |
+<dt class="hdlist1"> |
+<code>--stat</code> |
+</dt> |
+<dd> |
<p> |
-<code>{NO UPSTREAM}</code> is a special placeholder in <span class="fuchsia">magenta</span>. |
+ This is particularly useful to show <em>which</em> files have been changed in |
+ comparison to the upstream branch. |
</p> |
-<div class="ulist"><ul> |
-<li> |
+</dd> |
+<dt class="hdlist1"> |
+<code>-- <filename patterns>*</code> |
+</dt> |
+<dd> |
<p> |
-Branches which have this as their parent are usually misconfigured, and |
- should be assigned a parent by checking out the branch and running git branch |
- --set-upstream-to=<correct parent branch>. |
+ Restrict the diff to only show the diff for given files compared to the |
+ upstream. |
</p> |
-</li> |
-</ul></div> |
-</li> |
-</ul></div> |
-<div class="admonitionblock"> |
-<table><tr> |
-<td class="icon"> |
-<div class="title">Note</div> |
-</td> |
-<td class="content">If multiple branches are on the same commit, they will all be cyan.</td> |
-</tr></table> |
+</dd> |
+</dl></div> |
+</div></div> |
+</dd> |
+</dl></div> |
+</div> |
+</div> |
+<div class="sect1"> |
+<h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2> |
+<div class="sectionbody"> |
+<div class="sect2"> |
+<h3 id="_depot_tools_upstream_diff_default_args">depot-tools.upstream-diff.default-args</h3> |
+<div class="paragraph"><p>A list-configuration variable. Each instance of this config variable will be |
+prepended to all invocations of <code>git upstream-diff</code>, as if you had passed them |
+on the command line.</p></div> |
</div> |
</div> |
</div> |
<div class="sect1"> |
-<h2 id="_example">EXAMPLE</h2> |
+<h2 id="_suggested_aliases">SUGGESTED ALIASES</h2> |
<div class="sectionbody"> |
-<div class="paragraph"><p>Given the hypothetical demo repo in <a href="git-map.html">git-map(1)</a>'s EXAMPLE section, and |
-assuming that the <code>frozen_changes</code> branch was currently checked out, running |
-<em>git map-branches</em> would result in an output like:</p></div> |
+<div class="paragraph"><p>Some common short-hand aliases. Feel free to add these to your <em>~/.gitconfig</em> |
+file.</p></div> |
<div class="listingblock"> |
<div class="content"> |
-<pre><code><strong><span class="white">$ git map-branches</span></strong> |
-<span class="red">origin/master</span> |
- <span class="green">cool_feature</span> |
- <span class="green">subfeature</span> |
- <span class="aqua">frozen_changes *</span> |
- <span class="green">master</span> |
-<span class="fuchsia">{NO UPSTREAM}</span> |
- <span class="green">bogus_noparent</span> |
- <span class="aqua">duplicate_cool_feature_no_upstream</span></code></pre> |
+<pre><code>[alias] |
+ git udiff = upstream-diff</code></pre> |
</div></div> |
</div> |
</div> |
<div class="sect1"> |
<h2 id="_see_also">SEE ALSO</h2> |
<div class="sectionbody"> |
-<div class="paragraph"><p><a href="git-map.html">git-map(1)</a></p></div> |
+<div class="paragraph"><p><a href="git-rebase-update.html">git-rebase-update(1)</a></p></div> |
</div> |
</div> |
<div class="sect1"> |
@@ -851,7 +880,7 @@ from <a href="https://chromium.googlesource.com/chromium/tools/depot_tools.git"> |
<div id="footnotes"><hr /></div> |
<div id="footer"> |
<div id="footer-text"> |
-Last updated 2014-03-14 14:01:10 PDT |
+Last updated 2014-03-25 15:03:05 PDT |
</div> |
</div> |
</body> |