Autogenerated HTML docs for v1.6.3.2-214-gf4f78
[git/jnareb-git.git] / git-show-branch.html
blob405f0a6c37150a718819476d54005ad11b3c87d0
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.2.5" />
7 <style type="text/css">
8 /* Debug borders */
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11 border: 1px solid red;
15 body {
16 margin: 1em 5% 1em 5%;
19 a {
20 color: blue;
21 text-decoration: underline;
23 a:visited {
24 color: fuchsia;
27 em {
28 font-style: italic;
31 strong {
32 font-weight: bold;
35 tt {
36 color: navy;
39 h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
47 h1, h2, h3 {
48 border-bottom: 2px solid silver;
50 h2 {
51 padding-top: 0.5em;
53 h3 {
54 float: left;
56 h3 + * {
57 clear: left;
60 div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
65 hr {
66 border: 1px solid silver;
69 p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
74 pre {
75 padding: 0;
76 margin: 0;
79 span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
83 font-size: 1.1em;
85 span#email {
87 span#revision {
88 font-family: sans-serif;
91 div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
98 div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
102 div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
107 div#preamble,
108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110 div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
115 div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
120 div.content { /* Block element content. */
121 padding: 0;
124 /* Block element titles. */
125 div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
132 div.title + * {
133 margin-top: 0;
136 td div.title:first-child {
137 margin-top: 0.0em;
139 div.content div.title:first-child {
140 margin-top: 0.0em;
142 div.content + div.title {
143 margin-top: 0.0em;
146 div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
152 div.listingblock {
153 margin-right: 0%;
155 div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
161 div.quoteblock > div.content {
162 padding-left: 2.0em;
165 div.attribution {
166 text-align: right;
168 div.verseblock + div.attribution {
169 text-align: left;
172 div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
180 div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
185 div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
190 div.verseblock div.content {
191 white-space: pre;
194 div.imageblock div.content { padding-left: 0; }
195 div.imageblock img { border: 1px solid silver; }
196 span.image img { border-style: none; }
198 dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
202 dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
207 dd > *:first-child {
208 margin-top: 0;
211 ul, ol {
212 list-style-position: outside;
214 div.olist2 ol {
215 list-style-type: lower-alpha;
218 div.tableblock > table {
219 border: 3px solid #527bbd;
221 thead {
222 font-family: sans-serif;
223 font-weight: bold;
225 tfoot {
226 font-weight: bold;
229 div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
233 div.hlist td {
234 padding-bottom: 5px;
236 td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
241 td.hlist2 {
242 vertical-align: top;
245 @media print {
246 div#footer-badges { display: none; }
249 div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
262 div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
266 div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
270 div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
274 include1::./stylesheets/xhtml11-manpage.css[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
282 div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
289 div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
295 div.quoteblock-content {
296 padding-left: 2.0em;
299 div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc a:visited { color: blue; }
306 </style>
307 <title>git-show-branch(1)</title>
308 </head>
309 <body>
310 <div id="header">
311 <h1>
312 git-show-branch(1) Manual Page
313 </h1>
314 <h2>NAME</h2>
315 <div class="sectionbody">
316 <p>git-show-branch -
317 Show branches and their commits
318 </p>
319 </div>
320 </div>
321 <h2>SYNOPSIS</h2>
322 <div class="sectionbody">
323 <div class="verseblock">
324 <div class="content"><em>git show-branch</em> [--all] [--remotes] [--topo-order | --date-order]
325 [--current] [--color | --no-color]
326 [--more=&lt;n&gt; | --list | --independent | --merge-base]
327 [--no-name | --sha1-name] [--topics]
328 [&lt;rev&gt; | &lt;glob&gt;]&#8230;
329 <em>git show-branch</em> (-g|--reflog)[=&lt;n&gt;[,&lt;base&gt;]] [--list] [&lt;ref&gt;]</div></div>
330 </div>
331 <h2 id="_description">DESCRIPTION</h2>
332 <div class="sectionbody">
333 <div class="para"><p>Shows the commit ancestry graph starting from the commits named
334 with &lt;rev&gt;s or &lt;globs&gt;s (or all refs under $GIT_DIR/refs/heads
335 and/or $GIT_DIR/refs/tags) semi-visually.</p></div>
336 <div class="para"><p>It cannot show more than 29 branches and commits at a time.</p></div>
337 <div class="para"><p>It uses <tt>showbranch.default</tt> multi-valued configuration items if
338 no &lt;rev&gt; nor &lt;glob&gt; is given on the command line.</p></div>
339 </div>
340 <h2 id="_options">OPTIONS</h2>
341 <div class="sectionbody">
342 <div class="vlist"><dl>
343 <dt>
344 &lt;rev&gt;
345 </dt>
346 <dd>
348 Arbitrary extended SHA1 expression (see <a href="git-rev-parse.html">git-rev-parse(1)</a>)
349 that typically names a branch head or a tag.
350 </p>
351 </dd>
352 <dt>
353 &lt;glob&gt;
354 </dt>
355 <dd>
357 A glob pattern that matches branch or tag names under
358 $GIT_DIR/refs. For example, if you have many topic
359 branches under $GIT_DIR/refs/heads/topic, giving
360 <tt>topic/*</tt> would show all of them.
361 </p>
362 </dd>
363 <dt>
365 </dt>
366 <dt>
367 --remotes
368 </dt>
369 <dd>
371 Show the remote-tracking branches.
372 </p>
373 </dd>
374 <dt>
376 </dt>
377 <dt>
378 --all
379 </dt>
380 <dd>
382 Show both remote-tracking branches and local branches.
383 </p>
384 </dd>
385 <dt>
386 --current
387 </dt>
388 <dd>
390 With this option, the command includes the current
391 branch to the list of revs to be shown when it is not
392 given on the command line.
393 </p>
394 </dd>
395 <dt>
396 --topo-order
397 </dt>
398 <dd>
400 By default, the branches and their commits are shown in
401 reverse chronological order. This option makes them
402 appear in topological order (i.e., descendant commits
403 are shown before their parents).
404 </p>
405 </dd>
406 <dt>
407 --date-order
408 </dt>
409 <dd>
411 This option is similar to <em>--topo-order</em> in the sense that no
412 parent comes before all of its children, but otherwise commits
413 are ordered according to their commit date.
414 </p>
415 </dd>
416 <dt>
417 --sparse
418 </dt>
419 <dd>
421 By default, the output omits merges that are reachable
422 from only one tip being shown. This option makes them
423 visible.
424 </p>
425 </dd>
426 <dt>
427 --more=&lt;n&gt;
428 </dt>
429 <dd>
431 Usually the command stops output upon showing the commit
432 that is the common ancestor of all the branches. This
433 flag tells the command to go &lt;n&gt; more common commits
434 beyond that. When &lt;n&gt; is negative, display only the
435 &lt;reference&gt;s given, without showing the commit ancestry
436 tree.
437 </p>
438 </dd>
439 <dt>
440 --list
441 </dt>
442 <dd>
444 Synonym to <tt>--more=-1</tt>
445 </p>
446 </dd>
447 <dt>
448 --merge-base
449 </dt>
450 <dd>
452 Instead of showing the commit list, just act like the
453 <em>git-merge-base -a</em> command, except that it can accept
454 more than two heads.
455 </p>
456 </dd>
457 <dt>
458 --independent
459 </dt>
460 <dd>
462 Among the &lt;reference&gt;s given, display only the ones that
463 cannot be reached from any other &lt;reference&gt;.
464 </p>
465 </dd>
466 <dt>
467 --no-name
468 </dt>
469 <dd>
471 Do not show naming strings for each commit.
472 </p>
473 </dd>
474 <dt>
475 --sha1-name
476 </dt>
477 <dd>
479 Instead of naming the commits using the path to reach
480 them from heads (e.g. "master~2" to mean the grandparent
481 of "master"), name them with the unique prefix of their
482 object names.
483 </p>
484 </dd>
485 <dt>
486 --topics
487 </dt>
488 <dd>
490 Shows only commits that are NOT on the first branch given.
491 This helps track topic branches by hiding any commit that
492 is already in the main line of development. When given
493 "git show-branch --topics master topic1 topic2", this
494 will show the revisions given by "git rev-list &#94;master
495 topic1 topic2"
496 </p>
497 </dd>
498 <dt>
500 </dt>
501 <dt>
502 --reflog[=&lt;n&gt;[,&lt;base&gt;]] [&lt;ref&gt;]
503 </dt>
504 <dd>
506 Shows &lt;n&gt; most recent ref-log entries for the given
507 ref. If &lt;base&gt; is given, &lt;n&gt; entries going back from
508 that entry. &lt;base&gt; can be specified as count or date.
509 When no explicit &lt;ref&gt; parameter is given, it defaults to the
510 current branch (or <tt>HEAD</tt> if it is detached).
511 </p>
512 </dd>
513 <dt>
514 --color
515 </dt>
516 <dd>
518 Color the status sign (one of these: <tt>*</tt> <tt>!</tt> <tt>+</tt> <tt>-</tt>) of each commit
519 corresponding to the branch it's in.
520 </p>
521 </dd>
522 <dt>
523 --no-color
524 </dt>
525 <dd>
527 Turn off colored output, even when the configuration file gives the
528 default to color output.
529 </p>
530 </dd>
531 </dl></div>
532 <div class="para"><p>Note that --more, --list, --independent and --merge-base options
533 are mutually exclusive.</p></div>
534 </div>
535 <h2 id="_output">OUTPUT</h2>
536 <div class="sectionbody">
537 <div class="para"><p>Given N &lt;references&gt;, the first N lines are the one-line
538 description from their commit message. The branch head that is
539 pointed at by $GIT_DIR/HEAD is prefixed with an asterisk <tt>*</tt>
540 character while other heads are prefixed with a <tt>!</tt> character.</p></div>
541 <div class="para"><p>Following these N lines, one-line log for each commit is
542 displayed, indented N places. If a commit is on the I-th
543 branch, the I-th indentation character shows a <tt>+</tt> sign;
544 otherwise it shows a space. Merge commits are denoted by
545 a <tt>-</tt> sign. Each commit shows a short name that
546 can be used as an extended SHA1 to name that commit.</p></div>
547 <div class="para"><p>The following example shows three branches, "master", "fixes"
548 and "mhf":</p></div>
549 <div class="listingblock">
550 <div class="content">
551 <pre><tt>$ git show-branch master fixes mhf
552 * [master] Add 'git show-branch'.
553 ! [fixes] Introduce "reset type" flag to "git reset"
554 ! [mhf] Allow "+remote:local" refspec to cause --force when fetching.
556 + [mhf] Allow "+remote:local" refspec to cause --force when fetching.
557 + [mhf~1] Use git-octopus when pulling more than one heads.
558 + [fixes] Introduce "reset type" flag to "git reset"
559 + [mhf~2] "git fetch --force".
560 + [mhf~3] Use .git/remote/origin, not .git/branches/origin.
561 + [mhf~4] Make "git pull" and "git fetch" default to origin
562 + [mhf~5] Infamous 'octopus merge'
563 + [mhf~6] Retire git-parse-remote.
564 + [mhf~7] Multi-head fetch.
565 + [mhf~8] Start adding the $GIT_DIR/remotes/ support.
566 *++ [master] Add 'git show-branch'.</tt></pre>
567 </div></div>
568 <div class="para"><p>These three branches all forked from a common commit, [master],
569 whose commit message is "Add 'git show-branch'". The "fixes"
570 branch adds one commit "Introduce "reset type" flag to "git reset"".
571 The "mhf" branch adds many other commits. The current branch
572 is "master".</p></div>
573 </div>
574 <h2 id="_example">EXAMPLE</h2>
575 <div class="sectionbody">
576 <div class="para"><p>If you keep your primary branches immediately under
577 <tt>$GIT_DIR/refs/heads</tt>, and topic branches in subdirectories of
578 it, having the following in the configuration file may help:</p></div>
579 <div class="listingblock">
580 <div class="content">
581 <pre><tt>[showbranch]
582 default = --topo-order
583 default = heads/*
584 </tt></pre>
585 </div></div>
586 <div class="para"><p>With this, <tt>git show-branch</tt> without extra parameters would show
587 only the primary branches. In addition, if you happen to be on
588 your topic branch, it is shown as well.</p></div>
589 <div class="listingblock">
590 <div class="content">
591 <pre><tt>$ git show-branch --reflog="10,1 hour ago" --list master</tt></pre>
592 </div></div>
593 <div class="para"><p>shows 10 reflog entries going back from the tip as of 1 hour ago.
594 Without <tt>--list</tt>, the output also shows how these tips are
595 topologically related with each other.</p></div>
596 </div>
597 <h2 id="_author">Author</h2>
598 <div class="sectionbody">
599 <div class="para"><p>Written by Junio C Hamano &lt;gitster@pobox.com&gt;</p></div>
600 </div>
601 <h2 id="_documentation">Documentation</h2>
602 <div class="sectionbody">
603 <div class="para"><p>Documentation by Junio C Hamano.</p></div>
604 </div>
605 <h2 id="_git">GIT</h2>
606 <div class="sectionbody">
607 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
608 </div>
609 <div id="footer">
610 <div id="footer-text">
611 Last updated 2009-06-03 08:27:19 UTC
612 </div>
613 </div>
614 </body>
615 </html>