commit eb5f85b13255cd995b813e7efe5a5f22fd687b0d
author Robert Iannucci <iannucci@chromium.org> Thu Jun 21 19:41:31 2018 +0000
committer Commit Bot <commit-bot@chromium.org> Thu Jun 21 19:41:31 2018 +0000
tree 82fe1bac29c8e3c1a962fb3cecf2299345506ef5
parent 4099daa97b38b2ddb95e34d9fc3e2d37f58df069

Fix minor regression in git_upstream_diff.

89734301bcf8c5e1f774a861b2e15e859b846c1d introduced a new useful feature
to `git upstream-diff`, but unfortunately also regressed the behavior
of the tool when used with additional arguments for `git diff`.

This adds some additional documentation to demonstrate the intended
original feature (and fixes some of the bit-rot in the documentation
pipeline).

R=agable@chromium.org, mattm@chromium.org

Change-Id: I3ae48db3232c1ac84a7edbfe2225a17cda391a1e
Reviewed-on: https://chromium-review.googlesource.com/1107491
Commit-Queue: Robbie Iannucci <iannucci@chromium.org>
Reviewed-by: Aaron Gable <agable@chromium.org>

man/html/git-upstream-diff.html

diff --git a/man/html/git-upstream-diff.html b/man/html/git-upstream-diff.html
index 98ba404..44e9063 100644
--- a/man/html/git-upstream-diff.html
+++ b/man/html/git-upstream-diff.html
@@ -755,7 +755,7 @@
 <h2 id="_synopsis">SYNOPSIS</h2>
 <div class="sectionbody">
 <div class="verseblock">
-<pre class="content"><em>git upstream-diff</em> [--wordwise] [branch] [&lt;extra args for git-diff&gt;*]</pre>
+<pre class="content"><em>git upstream-diff</em> [--wordwise] [--branch branch] [&lt;extra args for git-diff&gt;*]</pre>
 <div class="attribution">
 </div></div>
 </div>
@@ -763,7 +763,10 @@
 <div class="sect1">
 <h2 id="_description">DESCRIPTION</h2>
 <div class="sectionbody">
-<div class="paragraph"><p>Shows a diff between a branch and its upstream. If the branch is omitted, the tool shows the diff for the current branch. This is <em>roughly</em> the same as:</p></div>
+<div class="paragraph"><p>Shows a diff between a branch and its upstream. If the --branch option is
+omitted or "HEAD", the tool shows the diff for the current branch. Any
+additional arguments are passed through to the underlying git-diff command. This
+is <em>roughly</em> the same as:</p></div>
 <div class="listingblock">
 <div class="content">
 <pre><code>git diff --patience -C -C branch@{upstream}  <b>&lt;1&gt;</b> <b>&lt;2&gt;</b></code></pre>
@@ -789,6 +792,20 @@
 <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 class="paragraph"><p>Since any additional options are passed through to git-diff unchanged, you can
+use this as a general replacement for <code>git diff</code> for things like:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><code>$ # See what changed in a file on the current branch
+$ git upstream-diff some/file.py
+...
+
+$ # Omit deleted files from the diff
+$ git upstream-diff --diff-filter d
+...
+
+$ # etc.</code></pre>
+</div></div>
 </div>
 </div>
 <div class="sect1">
@@ -895,7 +912,7 @@
 <div id="footnotes"><hr /></div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2017-11-03 14:35:37 PDT
+Last updated 2018-06-20 00:12:01 PDT
 </div>
 </div>
 </body>