Autogenerated HTML docs for v1.2.4-g9201
[git.git] / git-show-branch.html
index 396c8b9..38ef502 100644 (file)
@@ -272,7 +272,10 @@ git-show-branch(1) Manual Page
 </div>\r
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
-<p><em>git-show-branch [--all] [--heads] [--tags] [--topo-order] [--more=&lt;n&gt; | --list | --independent | --merge-base] [--no-name | --sha1-name] [&lt;rev&gt; | &lt;glob&gt;]&#8230;</em></p>\r
+<div class="verseblock">\r
+<div class="content">git-show-branch [--all] [--heads] [--tags] [--topo-order] [--current]\r
+        [--more=&lt;n&gt; | --list | --independent | --merge-base]\r
+        [--no-name | --sha1-name] [&lt;rev&gt; | &lt;glob&gt;]&#8230;</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
@@ -280,6 +283,8 @@ git-show-branch(1) Manual Page
 with &lt;rev&gt;s or &lt;globs&gt;s (or all refs under $GIT_DIR/refs/heads\r
 and/or $GIT_DIR/refs/tags) semi-visually.</p>\r
 <p>It cannot show more than 29 branches and commits at a time.</p>\r
+<p>It uses <tt>showbranch.default</tt> multi-valued configuration items if\r
+no &lt;rev&gt; nor &lt;glob&gt; is given on the command line.</p>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
@@ -314,6 +319,16 @@ and/or $GIT_DIR/refs/tags) semi-visually.</p>
 </p>\r
 </dd>\r
 <dt>\r
+--current\r
+</dt>\r
+<dd>\r
+<p>\r
+        With this option, the command includes the current\r
+        branch to the list of revs to be shown when it is not\r
+        given on the command line.\r
+</p>\r
+</dd>\r
+<dt>\r
 --topo-order\r
 </dt>\r
 <dd>\r
@@ -342,7 +357,7 @@ and/or $GIT_DIR/refs/tags) semi-visually.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        Synomym to <tt>--more=-1</tt>\r
+        Synonym to <tt>--more=-1</tt>\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -391,19 +406,20 @@ are mutually exclusive.</p>
 <div class="sectionbody">\r
 <p>Given N &lt;references&gt;, the first N lines are the one-line\r
 description from their commit message.  The branch head that is\r
-pointed at by $GIT_DIR/HEAD is prefixed with an asterisk <em>*</em>\r
-character while other heads are prefixed with a <em>!</em> character.</p>\r
+pointed at by $GIT_DIR/HEAD is prefixed with an asterisk <tt>*</tt>\r
+character while other heads are prefixed with a <tt>!</tt> character.</p>\r
 <p>Following these N lines, one-line log for each commit is\r
 displayed, indented N places.  If a commit is on the I-th\r
-branch, the I-th indentation character shows a <em>+</em> sign;\r
-otherwise it shows a space.  Each commit shows a short name that\r
+branch, the I-th indentation character shows a <tt>+</tt> sign;\r
+otherwise it shows a space.  Merge commits are denoted by\r
+a <tt>-</tt> sign.  Each commit shows a short name that\r
 can be used as an extended SHA1 to name that commit.</p>\r
 <p>The following example shows three branches, "master", "fixes"\r
 and "mhf":</p>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>$ git show-branch master fixes mhf\r
-! [master] Add 'git show-branch'.\r
+* [master] Add 'git show-branch'.\r
  ! [fixes] Introduce "reset type" flag to "git reset"\r
   ! [mhf] Allow "+remote:local" refspec to cause --force when fetching.\r
 ---\r
@@ -417,12 +433,28 @@ and "mhf":</p>
   + [mhf~6] Retire git-parse-remote.\r
   + [mhf~7] Multi-head fetch.\r
   + [mhf~8] Start adding the $GIT_DIR/remotes/ support.\r
-+++ [master] Add 'git show-branch'.</tt></pre>\r
+*++ [master] Add 'git show-branch'.</tt></pre>\r
 </div></div>\r
 <p>These three branches all forked from a common commit, [master],\r
 whose commit message is "Add <em>git show-branch</em>.  "fixes" branch\r
 adds one commit <em>Introduce "reset type"</em>.  "mhf" branch has many\r
-other commits.</p>\r
+other commits.  The current branch is "master".</p>\r
+</div>\r
+<h2>EXAMPLE</h2>\r
+<div class="sectionbody">\r
+<p>If you keep your primary branches immediately under\r
+<tt>$GIT_DIR/refs/heads</tt>, and topic branches in subdirectories of\r
+it, having the following in the configuration file may help:</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>[showbranch]\r
+        default = --topo-order\r
+        default = heads/*\r
+</tt></pre>\r
+</div></div>\r
+<p>With this,<tt>git show-branch</tt> without extra parameters would show\r
+only the primary branches.  In addition, if you happen to be on\r
+your topic branch, it is shown as well.</p>\r
 </div>\r
 <h2>Author</h2>\r
 <div class="sectionbody">\r
@@ -438,7 +470,7 @@ other commits.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 06-Jan-2006 17:12:45 PDT\r
+Last updated 15-Jan-2006 02:13:29 PDT\r
 </div>\r
 </div>\r
 </body>\r