Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(3725)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: docs/html/git-map.html

Issue 200903002: Add documentation for git-map-branches, git-map, git-nav-downstream, (Closed) Base URL: https://chromium.googlesource.com/chromium/tools/depot_tools.git@documentation
Patch Set: rebase Created 6 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « docs/html/git-freeze.html ('k') | docs/html/git-map-branches.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/html/git-map.html
diff --git a/git_docs/htmlout/git-thaw.html b/docs/html/git-map.html
similarity index 72%
copy from git_docs/htmlout/git-thaw.html
copy to docs/html/git-map.html
index cc2683a5ff8111f639a12341fa5996a907382028..828e1c057695e35234afcc7f22298417c620a40e 100644
--- a/git_docs/htmlout/git-thaw.html
+++ b/docs/html/git-map.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-thaw(1)</title>
+<title>git-map(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -535,6 +535,13 @@ body.manpage div.sectionbody {
}
+div.listingblock > div.content {
+ background: rgb(28, 28, 28);
+}
+
+div.listingblock > div > pre > code {
+ color: rgb(187, 187, 187);
+}
</style>
<script type="text/javascript">
/*<![CDATA[*/
@@ -734,12 +741,12 @@ asciidoc.install();
<body class="manpage">
<div id="header">
<h1>
-git-thaw(1) Manual Page
+git-map(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
-<p>git-thaw -
- Un-freeze all changes on a frozen branch.
+<p>git-map -
+ Display history of all branches in a colorized terminal format.
</p>
</div>
</div>
@@ -748,7 +755,7 @@ git-thaw(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>git thaw</em></pre>
+<pre class="content"><em>git map</em> [&lt;extra_args&gt;&#8230;]</pre>
<div class="attribution">
</div></div>
</div>
@@ -756,31 +763,116 @@ git-thaw(1) Manual Page
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p><code>git thaw</code> takes a frozen branch (as made by <a href="git-freeze.html">git-freeze(1)</a>), and returns
-it to the status that it was in before it was frozen.</p></div>
-<div class="paragraph"><p>If you freeze a branch multiple times (i.e. change files, freeze, change files,
-freeze), <code>git thaw</code> will thaw all of the freezes.</p></div>
+<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>
+</div>
+<div class="sect1">
+<h2 id="_options">OPTIONS</h2>
+<div class="sectionbody">
+<div class="dlist"><dl>
+<dt class="hdlist1">
+&lt;extra_args&gt;&#8230;
+</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.
+</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 &lt;value&gt;</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>&#8203;<strong><span class="blue-background red"> 7dcfe47 </span></strong> <span class="green">(</span>&#8203;<strong><span class="aqua">frozen_changes</span></strong>&#8203;<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>&#8203;<span class="red">origin/master</span>&#8203;<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Add neat feature
+* <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>&#8203;<strong><span class="lime">master</span></strong>&#8203;<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>&#8203;<strong><span class="lime">cool_feature</span></strong>&#8203;<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>&#8203;<strong><span class="lime">subfeature</span></strong>&#8203;<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">6d831ac</span></strong> <span class="green">(</span>&#8203;<strong><span class="fuchsia">spleen_tag</span></strong>&#8203;<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>&#8203;<strong><span class="lime">bogus_noparent</span></strong>&#8203;<span class="green">)</span> <span class="yellow">2014-03-11</span> ~ Wonderful beginnings</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-freeze.html">git-freeze(1)</a></p></div>
+<div class="paragraph"><p><a href="git-map-branches.html">git-map-branches(1)</a></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Part of the chromium depot_tools suite. These tools are meant to assist with the
-development of chromium and related projects. Download the tools from
-<a href="https://chromium.googlesource.com/chromium/tools/depot_tools.git">here</a>.</p></div>
+<div class="paragraph"><p>Part of the chromium <a href="depot_tools.html">depot_tools(1)</a> suite. These tools are meant to
+assist with the development of chromium and related projects. Download the tools
+from <a href="https://chromium.googlesource.com/chromium/tools/depot_tools.git">here</a>.</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2014-03-13 17:20:25 PDT
+Last updated 2014-03-14 14:01:55 PDT
</div>
</div>
</body>
« no previous file with comments | « docs/html/git-freeze.html ('k') | docs/html/git-map-branches.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698