Index: docs/html/git-squash-branch.html |
diff --git a/docs/html/git-map.html b/docs/html/git-squash-branch.html |
similarity index 79% |
copy from docs/html/git-map.html |
copy to docs/html/git-squash-branch.html |
index 828e1c057695e35234afcc7f22298417c620a40e..92797b54a3319b359bc16d8484d9f87dee586597 100644 |
--- a/docs/html/git-map.html |
+++ b/docs/html/git-squash-branch.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(1)</title> |
+<title>git-squash-branch(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(1) Manual Page |
+git-squash-branch(1) Manual Page |
</h1> |
<h2>NAME</h2> |
<div class="sectionbody"> |
-<p>git-map - |
- Display history of all branches in a colorized terminal format. |
+<p>git-squash-branch - |
+ Takes all commits in a single branch and replaces them with a single commit. |
</p> |
</div> |
</div> |
@@ -755,7 +755,7 @@ git-map(1) Manual Page |
<h2 id="_synopsis">SYNOPSIS</h2> |
<div class="sectionbody"> |
<div class="verseblock"> |
-<pre class="content"><em>git map</em> [<extra_args>…]</pre> |
+<pre class="content"><em>git squash-branch</em> [-m <message>]</pre> |
<div class="attribution"> |
</div></div> |
</div> |
@@ -763,36 +763,19 @@ git-map(1) Manual Page |
<div class="sect1"> |
<h2 id="_description">DESCRIPTION</h2> |
<div class="sectionbody"> |
-<div class="paragraph"><p>Git map formats the output of <code>git log --graph</code> from all refs such that:</p></div> |
-<div class="ulist"><ul> |
-<li> |
-<p> |
-Current branch is <span class="aqua">cyan</span>. |
-</p> |
-</li> |
-<li> |
-<p> |
-Local branches are <span class="green">green</span>. |
-</p> |
-</li> |
-<li> |
-<p> |
-Remote branches are <span class="red">red</span>. |
-</p> |
-</li> |
-<li> |
-<p> |
-Tags are <span class="fuchsia">magenta</span>. |
-</p> |
-</li> |
-<li> |
-<p> |
-The currently checked out commit is highlighted with a <span class="yellow blue-background">blue background</span>. |
-</p> |
-</li> |
-</ul></div> |
-<div class="paragraph"><p>The output is automatically piped through the <code>less</code> pager command, even on |
-windows.</p></div> |
+<div class="paragraph"><p><code>git squash-branch</code> is a simple helper command. It takes all the commits on the |
+current branch from the <em>merge_base</em> to HEAD, and reduces them to a single |
+commit. The new commit will contain a summary of all the commits which were |
+squashed, preceeded by a header message indicating that it’s the result of a |
+squash (or the message you pass on the command line.).</p></div> |
+<div class="paragraph"><p>Squashing branches is useful when trying to rebase-update over branches which |
+were pushed to their upsteram (or committed by the <em>Commit Queue</em>), and then |
+conflicting changes landed in upstream on top of the push/commit. If you know |
+that your branch was committed but <a href="git-rebase-update.html">git-rebase-update(1)</a> isn’t able to |
+automatically clean it, you can squash the troublesome branch before <code>git |
+rebase-update</code>, and then when <code>git rebase-update</code> presents the conflict, you can |
+verify that the conflict diff is what you expected (and then skip it with |
+<code>git rebase --skip</code>).</p></div> |
</div> |
</div> |
<div class="sect1"> |
@@ -800,64 +783,75 @@ windows.</p></div> |
<div class="sectionbody"> |
<div class="dlist"><dl> |
<dt class="hdlist1"> |
-<extra_args>… |
+-m <message> |
+</dt> |
+<dt class="hdlist1"> |
+--message=<message> |
</dt> |
<dd> |
<p> |
- Extra parameters to pass to the internal <a href="git-log.html">git-log(1)</a> invocation. This |
- can be used to restrict what refs <em>git map</em> operates on, etc. |
+ Optional message to use for the first line of the squashed commit. If omitted, |
+ it defaults to "git squash commit.". |
</p> |
-<div class="paragraph"><p>If you run git map with a series of fixed arguments frequently, you can use |
-the depot_tools.map_extra configuration variable to pre-set arguments (See |
-<code>CONFIGURATION VARIABLES</code>)</p></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_map_extra">depot_tools.map_extra</h3> |
-<div class="paragraph"><p>Each value of the <em>depot_tools.map_extra</em> config variable is applied as an |
-additional argument to <code>git log</code> during the execution of git map. If you wish to |
-configure this, use git <code>config --add depot_tools.map_extra <value></code> to do so.</p></div> |
-</div> |
-</div> |
-</div> |
-<div class="sect1"> |
<h2 id="_example">EXAMPLE</h2> |
<div class="sectionbody"> |
-<div class="paragraph"><p>Running <em>git map</em> would result in an output something like:</p></div> |
<div class="listingblock"> |
<div class="content"> |
<pre><code><strong><span class="white">$ git map</span></strong> |
<span class="white blue-background">*</span>​<strong><span class="blue-background red"> 7dcfe47 </span></strong> <span class="green">(</span>​<strong><span class="aqua">frozen_changes</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-12</span> ~ FREEZE.unindexed |
* <strong><span class="red">4b0c180</span></strong> <span class="yellow">2014-03-12</span> ~ modfile |
* <strong><span class="red">59a7cca</span></strong> <span class="yellow">2014-03-12</span> ~ a deleted file |
-* <strong><span class="red">6bec695</span></strong> <span class="green">(</span>​<span class="red">origin/master</span>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Add neat feature |
+* <strong><span class="red">6bec695</span></strong> <span class="green">(</span>​<span class="red">origin/master</span>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Add neat feature <strong><span class="white"><(frozen_changes)</span></strong> |
* <strong><span class="red">d15a38a</span></strong> <span class="yellow">2014-03-11</span> ~ Epic README update |
* <strong><span class="red">d559894</span></strong> <span class="green">(</span>​<strong><span class="lime">master</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Important upstream change |
<span class="red">|</span> * <strong><span class="red">9c311fd</span></strong> <span class="green">(</span>​<strong><span class="lime">cool_feature</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Respond to CL comments |
<span class="red">|</span> <span class="green">|</span> * <strong><span class="red">2a1eeb2</span></strong> <span class="green">(</span>​<strong><span class="lime">subfeature</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ integrate with CoolService |
<span class="red">|</span> <span class="green">|</span> * <strong><span class="red">d777af6</span></strong> <span class="yellow">2014-03-11</span> ~ slick commenting action |
<span class="red">|</span> <span class="green">|/</span> |
-<span class="red">|</span> * <strong><span class="red">265803a</span></strong> <span class="yellow">2014-03-11</span> ~ another improvement |
+<span class="red">|</span> * <strong><span class="red">265803a</span></strong> <span class="yellow">2014-03-11</span> ~ another improvement <strong><span class="white"><(subfeature)</span></strong> |
<span class="red">|</span> * <strong><span class="red">6d831ac</span></strong> <span class="green">(</span>​<strong><span class="fuchsia">spleen_tag</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Refactor spleen |
<span class="red">|</span> * <strong><span class="red">82e74ab</span></strong> <span class="yellow">2014-03-11</span> ~ Add widget |
<span class="red">|/</span> |
-* <strong><span class="red">d08c5b3</span></strong> <span class="green">(</span>​<strong><span class="lime">bogus_noparent</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Wonderful beginnings</code></pre> |
+* <strong><span class="red">d08c5b3</span></strong> <span class="green">(</span>​<strong><span class="lime">bogus_noparent</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Wonderful beginnings <strong><span class="white"><(cool_feature)</span></strong> |
+<strong><span class="white">$ git squash-branch "cool squash demo"</span></strong> |
+<strong><span class="white">$ git map</span></strong> |
+<span class="white blue-background">*</span>​<strong><span class="blue-background red"> 2c81508 </span></strong> <span class="green">(</span>​<strong><span class="aqua">frozen_changes</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-22</span> ~ cool squash demo |
+* <strong><span class="red">6bec695</span></strong> <span class="green">(</span>​<span class="red">origin/master</span>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Add neat feature <strong><span class="white"><(frozen_changes)</span></strong> |
+* <strong><span class="red">d15a38a</span></strong> <span class="yellow">2014-03-11</span> ~ Epic README update |
+* <strong><span class="red">d559894</span></strong> <span class="green">(</span>​<strong><span class="lime">master</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Important upstream change |
+<span class="red">|</span> * <strong><span class="red">9c311fd</span></strong> <span class="green">(</span>​<strong><span class="lime">cool_feature</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Respond to CL comments |
+<span class="red">|</span> <span class="green">|</span> * <strong><span class="red">2a1eeb2</span></strong> <span class="green">(</span>​<strong><span class="lime">subfeature</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ integrate with CoolService |
+<span class="red">|</span> <span class="green">|</span> * <strong><span class="red">d777af6</span></strong> <span class="yellow">2014-03-11</span> ~ slick commenting action |
+<span class="red">|</span> <span class="green">|/</span> |
+<span class="red">|</span> * <strong><span class="red">265803a</span></strong> <span class="yellow">2014-03-11</span> ~ another improvement <strong><span class="white"><(subfeature)</span></strong> |
+<span class="red">|</span> * <strong><span class="red">6d831ac</span></strong> <span class="green">(</span>​<strong><span class="fuchsia">spleen_tag</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Refactor spleen |
+<span class="red">|</span> * <strong><span class="red">82e74ab</span></strong> <span class="yellow">2014-03-11</span> ~ Add widget |
+<span class="red">|/</span> |
+* <strong><span class="red">d08c5b3</span></strong> <span class="green">(</span>​<strong><span class="lime">bogus_noparent</span></strong>​<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Wonderful beginnings <strong><span class="white"><(cool_feature)</span></strong></code></pre> |
+</div></div> |
+</div> |
+</div> |
+<div class="sect1"> |
+<h2 id="_suggested_aliases">SUGGESTED ALIASES</h2> |
+<div class="sectionbody"> |
+<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>[alias] |
+ git squash = squash-branch</code></pre> |
</div></div> |
-<div class="paragraph"><p>As you can see, the structure of the commit history is visible, particularly |
-what the parents of each commit are. In order to see the <em>upstream</em> |
-relationships of the branches (i.e. which branch is tracking which other |
-branch), use the <a href="git-map-branches.html">git-map-branches(1)</a> command.</p></div> |
</div> |
</div> |
<div class="sect1"> |
<h2 id="_see_also">SEE ALSO</h2> |
<div class="sectionbody"> |
-<div class="paragraph"><p><a href="git-map-branches.html">git-map-branches(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"> |
@@ -872,7 +866,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:55 PDT |
+Last updated 2014-03-25 15:09:11 PDT |
</div> |
</div> |
</body> |