doc/source/en/TortoiseGit/git_doc/git-show-branch.html.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-show-branch(1)">\r
   5 <articleinfo>\r
   6     <title>git-show-branch(1)</title>\r
   7         <indexterm>\r
   8                 <primary>git-show-branch(1)</primary>\r
   9         </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-show-branch - Show branches and their commits</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout><emphasis>git show-branch</emphasis> [--all] [--remotes] [--topo-order] [--current]\r
  19                 [--more=&lt;n&gt; | --list | --independent | --merge-base]\r
  20                 [--no-name | --sha1-name] [--topics] [&lt;rev&gt; | &lt;glob&gt;]&#8230;\r
  21 <emphasis>git show-branch</emphasis> (-g|--reflog)[=&lt;n&gt;[,&lt;base&gt;]] [--list] [&lt;ref&gt;]</literallayout>\r
  22 </blockquote>\r
  23 </simplesect>\r
  24 <simplesect id="_description">\r
  25 <title>DESCRIPTION</title>\r
  26 <simpara>Shows the commit ancestry graph starting from the commits named\r
  27 with &lt;rev&gt;s or &lt;globs&gt;s (or all refs under $GIT_DIR/refs/heads\r
  28 and/or $GIT_DIR/refs/tags) semi-visually.</simpara>\r
  29 <simpara>It cannot show more than 29 branches and commits at a time.</simpara>\r
  30 <simpara>It uses <literal>showbranch.default</literal> multi-valued configuration items if\r
  31 no &lt;rev&gt; nor &lt;glob&gt; is given on the command line.</simpara>\r
  32 </simplesect>\r
  33 <simplesect id="_options">\r
  34 <title>OPTIONS</title>\r
  35 <variablelist>\r
  36 <varlistentry>\r
  37 <term>\r
  38 &lt;rev&gt;\r
  39 </term>\r
  40 <listitem>\r
  41 <simpara>\r
  42         Arbitrary extended SHA1 expression (see <xref linkend="git-rev-parse(1)"/>)\r
  43         that typically names a branch head or a tag.\r
  44 </simpara>\r
  45 </listitem>\r
  46 </varlistentry>\r
  47 <varlistentry>\r
  48 <term>\r
  49 &lt;glob&gt;\r
  50 </term>\r
  51 <listitem>\r
  52 <simpara>\r
  53         A glob pattern that matches branch or tag names under\r
  54         $GIT_DIR/refs.  For example, if you have many topic\r
  55         branches under $GIT_DIR/refs/heads/topic, giving\r
  56         <literal>topic/*</literal> would show all of them.\r
  57 </simpara>\r
  58 </listitem>\r
  59 </varlistentry>\r
  60 <varlistentry>\r
  61 <term>\r
  62 -r\r
  63 </term>\r
  64 <term>\r
  65 --remotes\r
  66 </term>\r
  67 <listitem>\r
  68 <simpara>\r
  69         Show the remote-tracking branches.\r
  70 </simpara>\r
  71 </listitem>\r
  72 </varlistentry>\r
  73 <varlistentry>\r
  74 <term>\r
  75 -a\r
  76 </term>\r
  77 <term>\r
  78 --all\r
  79 </term>\r
  80 <listitem>\r
  81 <simpara>\r
  82         Show both remote-tracking branches and local branches.\r
  83 </simpara>\r
  84 </listitem>\r
  85 </varlistentry>\r
  86 <varlistentry>\r
  87 <term>\r
  88 --current\r
  89 </term>\r
  90 <listitem>\r
  91 <simpara>\r
  92         With this option, the command includes the current\r
  93         branch to the list of revs to be shown when it is not\r
  94         given on the command line.\r
  95 </simpara>\r
  96 </listitem>\r
  97 </varlistentry>\r
  98 <varlistentry>\r
  99 <term>\r
 100 --topo-order\r
 101 </term>\r
 102 <listitem>\r
 103 <simpara>\r
 104         By default, the branches and their commits are shown in\r
 105         reverse chronological order.  This option makes them\r
 106         appear in topological order (i.e., descendant commits\r
 107         are shown before their parents).\r
 108 </simpara>\r
 109 </listitem>\r
 110 </varlistentry>\r
 111 <varlistentry>\r
 112 <term>\r
 113 --sparse\r
 114 </term>\r
 115 <listitem>\r
 116 <simpara>\r
 117         By default, the output omits merges that are reachable\r
 118         from only one tip being shown.  This option makes them\r
 119         visible.\r
 120 </simpara>\r
 121 </listitem>\r
 122 </varlistentry>\r
 123 <varlistentry>\r
 124 <term>\r
 125 --more=&lt;n&gt;\r
 126 </term>\r
 127 <listitem>\r
 128 <simpara>\r
 129         Usually the command stops output upon showing the commit\r
 130         that is the common ancestor of all the branches.  This\r
 131         flag tells the command to go &lt;n&gt; more common commits\r
 132         beyond that.  When &lt;n&gt; is negative, display only the\r
 133         &lt;reference&gt;s given, without showing the commit ancestry\r
 134         tree.\r
 135 </simpara>\r
 136 </listitem>\r
 137 </varlistentry>\r
 138 <varlistentry>\r
 139 <term>\r
 140 --list\r
 141 </term>\r
 142 <listitem>\r
 143 <simpara>\r
 144         Synonym to <literal>--more=-1</literal>\r
 145 </simpara>\r
 146 </listitem>\r
 147 </varlistentry>\r
 148 <varlistentry>\r
 149 <term>\r
 150 --merge-base\r
 151 </term>\r
 152 <listitem>\r
 153 <simpara>\r
 154         Instead of showing the commit list, just act like the\r
 155         <emphasis>git-merge-base -a</emphasis> command, except that it can accept\r
 156         more than two heads.\r
 157 </simpara>\r
 158 </listitem>\r
 159 </varlistentry>\r
 160 <varlistentry>\r
 161 <term>\r
 162 --independent\r
 163 </term>\r
 164 <listitem>\r
 165 <simpara>\r
 166         Among the &lt;reference&gt;s given, display only the ones that\r
 167         cannot be reached from any other &lt;reference&gt;.\r
 168 </simpara>\r
 169 </listitem>\r
 170 </varlistentry>\r
 171 <varlistentry>\r
 172 <term>\r
 173 --no-name\r
 174 </term>\r
 175 <listitem>\r
 176 <simpara>\r
 177         Do not show naming strings for each commit.\r
 178 </simpara>\r
 179 </listitem>\r
 180 </varlistentry>\r
 181 <varlistentry>\r
 182 <term>\r
 183 --sha1-name\r
 184 </term>\r
 185 <listitem>\r
 186 <simpara>\r
 187         Instead of naming the commits using the path to reach\r
 188         them from heads (e.g. "master~2" to mean the grandparent\r
 189         of "master"), name them with the unique prefix of their\r
 190         object names.\r
 191 </simpara>\r
 192 </listitem>\r
 193 </varlistentry>\r
 194 <varlistentry>\r
 195 <term>\r
 196 --topics\r
 197 </term>\r
 198 <listitem>\r
 199 <simpara>\r
 200         Shows only commits that are NOT on the first branch given.\r
 201         This helps track topic branches by hiding any commit that\r
 202         is already in the main line of development.  When given\r
 203         "git show-branch --topics master topic1 topic2", this\r
 204         will show the revisions given by "git rev-list &#94;master\r
 205         topic1 topic2"\r
 206 </simpara>\r
 207 </listitem>\r
 208 </varlistentry>\r
 209 <varlistentry>\r
 210 <term>\r
 211 -g\r
 212 </term>\r
 213 <term>\r
 214 --reflog[=&lt;n&gt;[,&lt;base&gt;]] [&lt;ref&gt;]\r
 215 </term>\r
 216 <listitem>\r
 217 <simpara>\r
 218         Shows &lt;n&gt; most recent ref-log entries for the given\r
 219         ref.  If &lt;base&gt; is given, &lt;n&gt; entries going back from\r
 220         that entry.  &lt;base&gt; can be specified as count or date.\r
 221         When no explicit &lt;ref&gt; parameter is given, it defaults to the\r
 222         current branch (or <literal>HEAD</literal> if it is detached).\r
 223 </simpara>\r
 224 </listitem>\r
 225 </varlistentry>\r
 226 </variablelist>\r
 227 <simpara>Note that --more, --list, --independent and --merge-base options\r
 228 are mutually exclusive.</simpara>\r
 229 </simplesect>\r
 230 <simplesect id="_output">\r
 231 <title>OUTPUT</title>\r
 232 <simpara>Given N &lt;references&gt;, the first N lines are the one-line\r
 233 description from their commit message.  The branch head that is\r
 234 pointed at by $GIT_DIR/HEAD is prefixed with an asterisk <literal>*</literal>\r
 235 character while other heads are prefixed with a <literal>!</literal> character.</simpara>\r
 236 <simpara>Following these N lines, one-line log for each commit is\r
 237 displayed, indented N places.  If a commit is on the I-th\r
 238 branch, the I-th indentation character shows a <literal>+</literal> sign;\r
 239 otherwise it shows a space.  Merge commits are denoted by\r
 240 a <literal>-</literal> sign.  Each commit shows a short name that\r
 241 can be used as an extended SHA1 to name that commit.</simpara>\r
 242 <simpara>The following example shows three branches, "master", "fixes"\r
 243 and "mhf":</simpara>\r
 244 <literallayout>$ git show-branch master fixes mhf\r
 245 * [master] Add 'git show-branch'.\r
 246  ! [fixes] Introduce "reset type" flag to "git reset"\r
 247   ! [mhf] Allow "+remote:local" refspec to cause --force when fetching.\r
 248 ---\r
 249   + [mhf] Allow "+remote:local" refspec to cause --force when fetching.\r
 250   + [mhf~1] Use git-octopus when pulling more than one heads.\r
 251  +  [fixes] Introduce "reset type" flag to "git reset"\r
 252   + [mhf~2] "git fetch --force".\r
 253   + [mhf~3] Use .git/remote/origin, not .git/branches/origin.\r
 254   + [mhf~4] Make "git pull" and "git fetch" default to origin\r
 255   + [mhf~5] Infamous 'octopus merge'\r
 256   + [mhf~6] Retire git-parse-remote.\r
 257   + [mhf~7] Multi-head fetch.\r
 258   + [mhf~8] Start adding the $GIT_DIR/remotes/ support.\r
 259 *++ [master] Add 'git show-branch'.</literallayout>\r
 260 <simpara>These three branches all forked from a common commit, [master],\r
 261 whose commit message is "Add <emphasis>git show-branch</emphasis>.  "fixes" branch\r
 262 adds one commit <emphasis>Introduce "reset type"</emphasis>.  "mhf" branch has many\r
 263 other commits.  The current branch is "master".</simpara>\r
 264 </simplesect>\r
 265 <simplesect id="_example">\r
 266 <title>EXAMPLE</title>\r
 267 <simpara>If you keep your primary branches immediately under\r
 268 <literal>$GIT_DIR/refs/heads</literal>, and topic branches in subdirectories of\r
 269 it, having the following in the configuration file may help:</simpara>\r
 270 <literallayout>[showbranch]\r
 271         default = --topo-order\r
 272         default = heads/*</literallayout>\r
 273 <simpara>With this, <literal>git show-branch</literal> without extra parameters would show\r
 274 only the primary branches.  In addition, if you happen to be on\r
 275 your topic branch, it is shown as well.</simpara>\r
 276 <literallayout>$ git show-branch --reflog="10,1 hour ago" --list master</literallayout>\r
 277 <simpara>shows 10 reflog entries going back from the tip as of 1 hour ago.\r
 278 Without <literal>--list</literal>, the output also shows how these tips are\r
 279 topologically related with each other.</simpara>\r
 280 </simplesect>\r
 281 <simplesect id="_author">\r
 282 <title>Author</title>\r
 283 <simpara>Written by Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;</simpara>\r
 284 </simplesect>\r
 285 <simplesect id="_documentation">\r
 286 <title>Documentation</title>\r
 287 <simpara>Documentation by Junio C Hamano.</simpara>\r
 288 </simplesect>\r
 289 <simplesect id="_git">\r
 290 <title>GIT</title>\r
 291 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
 292 </simplesect>\r
 293 </article>\r