Autogenerated HTML docs for v1.7.4.1-294-gaf4c
[git/jnareb-git.git] / git-show-branch.html
blobc06031a571cc94ccab0927c5f583593d5c2e684a
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>git-show-branch(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-show-branch(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-show-branch -
411 Show branches and their commits
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="verseblock">
418 <div class="verseblock-content"><em>git show-branch</em> [-a|--all] [-r|--remotes] [--topo-order | --date-order]
419 [--current] [--color[=&lt;when&gt;] | --no-color] [--sparse]
420 [--more=&lt;n&gt; | --list | --independent | --merge-base]
421 [--no-name | --sha1-name] [--topics]
422 [(&lt;rev&gt; | &lt;glob&gt;)&#8230;]</div>
423 <div class="verseblock-attribution">
424 </div></div>
425 <div class="paragraph"><p><em>git show-branch</em> (-g|--reflog)[=&lt;n&gt;[,&lt;base&gt;]] [--list] [&lt;ref&gt;]</p></div>
426 </div>
427 <h2 id="_description">DESCRIPTION</h2>
428 <div class="sectionbody">
429 <div class="paragraph"><p>Shows the commit ancestry graph starting from the commits named
430 with &lt;rev&gt;s or &lt;globs&gt;s (or all refs under refs/heads
431 and/or refs/tags) semi-visually.</p></div>
432 <div class="paragraph"><p>It cannot show more than 29 branches and commits at a time.</p></div>
433 <div class="paragraph"><p>It uses <tt>showbranch.default</tt> multi-valued configuration items if
434 no &lt;rev&gt; nor &lt;glob&gt; is given on the command line.</p></div>
435 </div>
436 <h2 id="_options">OPTIONS</h2>
437 <div class="sectionbody">
438 <div class="dlist"><dl>
439 <dt class="hdlist1">
440 &lt;rev&gt;
441 </dt>
442 <dd>
444 Arbitrary extended SHA1 expression (see <a href="gitrevisions.html">gitrevisions(7)</a>)
445 that typically names a branch head or a tag.
446 </p>
447 </dd>
448 <dt class="hdlist1">
449 &lt;glob&gt;
450 </dt>
451 <dd>
453 A glob pattern that matches branch or tag names under
454 refs/. For example, if you have many topic
455 branches under refs/heads/topic, giving
456 <tt>topic/*</tt> would show all of them.
457 </p>
458 </dd>
459 <dt class="hdlist1">
461 </dt>
462 <dt class="hdlist1">
463 --remotes
464 </dt>
465 <dd>
467 Show the remote-tracking branches.
468 </p>
469 </dd>
470 <dt class="hdlist1">
472 </dt>
473 <dt class="hdlist1">
474 --all
475 </dt>
476 <dd>
478 Show both remote-tracking branches and local branches.
479 </p>
480 </dd>
481 <dt class="hdlist1">
482 --current
483 </dt>
484 <dd>
486 With this option, the command includes the current
487 branch to the list of revs to be shown when it is not
488 given on the command line.
489 </p>
490 </dd>
491 <dt class="hdlist1">
492 --topo-order
493 </dt>
494 <dd>
496 By default, the branches and their commits are shown in
497 reverse chronological order. This option makes them
498 appear in topological order (i.e., descendant commits
499 are shown before their parents).
500 </p>
501 </dd>
502 <dt class="hdlist1">
503 --date-order
504 </dt>
505 <dd>
507 This option is similar to <em>--topo-order</em> in the sense that no
508 parent comes before all of its children, but otherwise commits
509 are ordered according to their commit date.
510 </p>
511 </dd>
512 <dt class="hdlist1">
513 --sparse
514 </dt>
515 <dd>
517 By default, the output omits merges that are reachable
518 from only one tip being shown. This option makes them
519 visible.
520 </p>
521 </dd>
522 <dt class="hdlist1">
523 --more=&lt;n&gt;
524 </dt>
525 <dd>
527 Usually the command stops output upon showing the commit
528 that is the common ancestor of all the branches. This
529 flag tells the command to go &lt;n&gt; more common commits
530 beyond that. When &lt;n&gt; is negative, display only the
531 &lt;reference&gt;s given, without showing the commit ancestry
532 tree.
533 </p>
534 </dd>
535 <dt class="hdlist1">
536 --list
537 </dt>
538 <dd>
540 Synonym to <tt>--more=-1</tt>
541 </p>
542 </dd>
543 <dt class="hdlist1">
544 --merge-base
545 </dt>
546 <dd>
548 Instead of showing the commit list, determine possible
549 merge bases for the specified commits. All merge bases
550 will be contained in all specified commits. This is
551 different from how <a href="git-merge-base.html">git-merge-base(1)</a> handles
552 the case of three or more commits.
553 </p>
554 </dd>
555 <dt class="hdlist1">
556 --independent
557 </dt>
558 <dd>
560 Among the &lt;reference&gt;s given, display only the ones that
561 cannot be reached from any other &lt;reference&gt;.
562 </p>
563 </dd>
564 <dt class="hdlist1">
565 --no-name
566 </dt>
567 <dd>
569 Do not show naming strings for each commit.
570 </p>
571 </dd>
572 <dt class="hdlist1">
573 --sha1-name
574 </dt>
575 <dd>
577 Instead of naming the commits using the path to reach
578 them from heads (e.g. "master~2" to mean the grandparent
579 of "master"), name them with the unique prefix of their
580 object names.
581 </p>
582 </dd>
583 <dt class="hdlist1">
584 --topics
585 </dt>
586 <dd>
588 Shows only commits that are NOT on the first branch given.
589 This helps track topic branches by hiding any commit that
590 is already in the main line of development. When given
591 "git show-branch --topics master topic1 topic2", this
592 will show the revisions given by "git rev-list &#94;master
593 topic1 topic2"
594 </p>
595 </dd>
596 <dt class="hdlist1">
598 </dt>
599 <dt class="hdlist1">
600 --reflog[=&lt;n&gt;[,&lt;base&gt;]] [&lt;ref&gt;]
601 </dt>
602 <dd>
604 Shows &lt;n&gt; most recent ref-log entries for the given
605 ref. If &lt;base&gt; is given, &lt;n&gt; entries going back from
606 that entry. &lt;base&gt; can be specified as count or date.
607 When no explicit &lt;ref&gt; parameter is given, it defaults to the
608 current branch (or <tt>HEAD</tt> if it is detached).
609 </p>
610 </dd>
611 <dt class="hdlist1">
612 --color[=&lt;when&gt;]
613 </dt>
614 <dd>
616 Color the status sign (one of these: <tt>*</tt> <tt>!</tt> <tt>+</tt> <tt>-</tt>) of each commit
617 corresponding to the branch it&#8217;s in.
618 The value must be always (the default), never, or auto.
619 </p>
620 </dd>
621 <dt class="hdlist1">
622 --no-color
623 </dt>
624 <dd>
626 Turn off colored output, even when the configuration file gives the
627 default to color output.
628 Same as <tt>--color=never</tt>.
629 </p>
630 </dd>
631 </dl></div>
632 <div class="paragraph"><p>Note that --more, --list, --independent and --merge-base options
633 are mutually exclusive.</p></div>
634 </div>
635 <h2 id="_output">OUTPUT</h2>
636 <div class="sectionbody">
637 <div class="paragraph"><p>Given N &lt;references&gt;, the first N lines are the one-line
638 description from their commit message. The branch head that is
639 pointed at by $GIT_DIR/HEAD is prefixed with an asterisk <tt>*</tt>
640 character while other heads are prefixed with a <tt>!</tt> character.</p></div>
641 <div class="paragraph"><p>Following these N lines, one-line log for each commit is
642 displayed, indented N places. If a commit is on the I-th
643 branch, the I-th indentation character shows a <tt>+</tt> sign;
644 otherwise it shows a space. Merge commits are denoted by
645 a <tt>-</tt> sign. Each commit shows a short name that
646 can be used as an extended SHA1 to name that commit.</p></div>
647 <div class="paragraph"><p>The following example shows three branches, "master", "fixes"
648 and "mhf":</p></div>
649 <div class="listingblock">
650 <div class="content">
651 <pre><tt>$ git show-branch master fixes mhf
652 * [master] Add 'git show-branch'.
653 ! [fixes] Introduce "reset type" flag to "git reset"
654 ! [mhf] Allow "+remote:local" refspec to cause --force when fetching.
656 + [mhf] Allow "+remote:local" refspec to cause --force when fetching.
657 + [mhf~1] Use git-octopus when pulling more than one heads.
658 + [fixes] Introduce "reset type" flag to "git reset"
659 + [mhf~2] "git fetch --force".
660 + [mhf~3] Use .git/remote/origin, not .git/branches/origin.
661 + [mhf~4] Make "git pull" and "git fetch" default to origin
662 + [mhf~5] Infamous 'octopus merge'
663 + [mhf~6] Retire git-parse-remote.
664 + [mhf~7] Multi-head fetch.
665 + [mhf~8] Start adding the $GIT_DIR/remotes/ support.
666 *++ [master] Add 'git show-branch'.</tt></pre>
667 </div></div>
668 <div class="paragraph"><p>These three branches all forked from a common commit, [master],
669 whose commit message is "Add &#39;git show-branch&#39;".
670 The "fixes" branch adds one commit "Introduce "reset type" flag to
671 "git reset"". The "mhf" branch adds many other commits.
672 The current branch is "master".</p></div>
673 </div>
674 <h2 id="_example">EXAMPLE</h2>
675 <div class="sectionbody">
676 <div class="paragraph"><p>If you keep your primary branches immediately under
677 <tt>refs/heads</tt>, and topic branches in subdirectories of
678 it, having the following in the configuration file may help:</p></div>
679 <div class="listingblock">
680 <div class="content">
681 <pre><tt>[showbranch]
682 default = --topo-order
683 default = heads/*</tt></pre>
684 </div></div>
685 <div class="paragraph"><p>With this, <tt>git show-branch</tt> without extra parameters would show
686 only the primary branches. In addition, if you happen to be on
687 your topic branch, it is shown as well.</p></div>
688 <div class="listingblock">
689 <div class="content">
690 <pre><tt>$ git show-branch --reflog="10,1 hour ago" --list master</tt></pre>
691 </div></div>
692 <div class="paragraph"><p>shows 10 reflog entries going back from the tip as of 1 hour ago.
693 Without <tt>--list</tt>, the output also shows how these tips are
694 topologically related with each other.</p></div>
695 </div>
696 <h2 id="_git">GIT</h2>
697 <div class="sectionbody">
698 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
699 </div>
700 <div id="footer">
701 <div id="footer-text">
702 Last updated 2011-03-15 23:30:14 UTC
703 </div>
704 </div>
705 </body>
706 </html>