blob: 38ef5020af04c4ec87e84ab8614422428c18fb52 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231<!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 7.0.1" />
7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-show-branch(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-show-branch(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-show-branch -
269 Show branches and their commits.
270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano38064d52006-01-15 10:13:49275<div class="verseblock">
276<div class="content">git-show-branch [--all] [--heads] [--tags] [--topo-order] [--current]
277 [--more=&lt;n&gt; | --list | --independent | --merge-base]
278 [--no-name | --sha1-name] [&lt;rev&gt; | &lt;glob&gt;]&#8230;</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23279</div>
280<h2>DESCRIPTION</h2>
281<div class="sectionbody">
282<p>Shows the commit ancestry graph starting from the commits named
283with &lt;rev&gt;s or &lt;globs&gt;s (or all refs under $GIT_DIR/refs/heads
284and/or $GIT_DIR/refs/tags) semi-visually.</p>
285<p>It cannot show more than 29 branches and commits at a time.</p>
Junio C Hamano38064d52006-01-15 10:13:49286<p>It uses <tt>showbranch.default</tt> multi-valued configuration items if
287no &lt;rev&gt; nor &lt;glob&gt; is given on the command line.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23288</div>
289<h2>OPTIONS</h2>
290<div class="sectionbody">
291<dl>
292<dt>
293&lt;rev&gt;
294</dt>
295<dd>
296<p>
297 Arbitrary extended SHA1 expression (see <tt>git-rev-parse</tt>)
298 that typically names a branch HEAD or a tag.
299</p>
300</dd>
301<dt>
302&lt;glob&gt;
303</dt>
304<dd>
305<p>
306 A glob pattern that matches branch or tag names under
307 $GIT_DIR/refs. For example, if you have many topic
308 branches under $GIT_DIR/refs/heads/topic, giving
309 <tt>topic/*</tt> would show all of them.
310</p>
311</dd>
312<dt>
313--all --heads --tags
314</dt>
315<dd>
316<p>
317 Show all refs under $GIT_DIR/refs, $GIT_DIR/refs/heads,
318 and $GIT_DIR/refs/tags, respectively.
319</p>
320</dd>
321<dt>
Junio C Hamano38064d52006-01-15 10:13:49322--current
323</dt>
324<dd>
325<p>
326 With this option, the command includes the current
327 branch to the list of revs to be shown when it is not
328 given on the command line.
329</p>
330</dd>
331<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23332--topo-order
333</dt>
334<dd>
335<p>
336 By default, the branches and their commits are shown in
337 reverse chronological order. This option makes them
338 appear in topological order (i.e., descendant commits
339 are shown before their parents).
340</p>
341</dd>
342<dt>
343--more=&lt;n&gt;
344</dt>
345<dd>
346<p>
347 Usually the command stops output upon showing the commit
348 that is the common ancestor of all the branches. This
349 flag tells the command to go &lt;n&gt; more common commits
350 beyond that. When &lt;n&gt; is negative, display only the
351 &lt;reference&gt;s given, without showing the commit ancestry
352 tree.
353</p>
354</dd>
355<dt>
356--list
357</dt>
358<dd>
359<p>
Junio C Hamano38064d52006-01-15 10:13:49360 Synonym to <tt>--more=-1</tt>
Junio C Hamano1a4e8412005-12-27 08:17:23361</p>
362</dd>
363<dt>
364--merge-base
365</dt>
366<dd>
367<p>
368 Instead of showing the commit list, just act like the
369 <em>git-merge-base -a</em> command, except that it can accept
370 more than two heads.
371</p>
372</dd>
373<dt>
374--independent
375</dt>
376<dd>
377<p>
378 Among the &lt;reference&gt;s given, display only the ones that
379 cannot be reached from any other &lt;reference&gt;.
380</p>
381</dd>
382<dt>
383--no-name
384</dt>
385<dd>
386<p>
387 Do not show naming strings for each commit.
388</p>
389</dd>
390<dt>
391--sha1-name
392</dt>
393<dd>
394<p>
395 Instead of naming the commits using the path to reach
396 them from heads (e.g. "master~2" to mean the grandparent
397 of "master"), name them with the unique prefix of their
398 object names.
399</p>
400</dd>
401</dl>
402<p>Note that --more, --list, --independent and --merge-base options
403are mutually exclusive.</p>
404</div>
405<h2>OUTPUT</h2>
406<div class="sectionbody">
407<p>Given N &lt;references&gt;, the first N lines are the one-line
408description from their commit message. The branch head that is
Junio C Hamano38064d52006-01-15 10:13:49409pointed at by $GIT_DIR/HEAD is prefixed with an asterisk <tt>*</tt>
410character while other heads are prefixed with a <tt>!</tt> character.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23411<p>Following these N lines, one-line log for each commit is
412displayed, indented N places. If a commit is on the I-th
Junio C Hamano38064d52006-01-15 10:13:49413branch, the I-th indentation character shows a <tt>+</tt> sign;
414otherwise it shows a space. Merge commits are denoted by
415a <tt>-</tt> sign. Each commit shows a short name that
Junio C Hamano235a91e2006-01-07 01:13:58416can be used as an extended SHA1 to name that commit.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23417<p>The following example shows three branches, "master", "fixes"
418and "mhf":</p>
419<div class="listingblock">
420<div class="content">
421<pre><tt>$ git show-branch master fixes mhf
Junio C Hamano38064d52006-01-15 10:13:49422* [master] Add 'git show-branch'.
Junio C Hamano1a4e8412005-12-27 08:17:23423 ! [fixes] Introduce "reset type" flag to "git reset"
424 ! [mhf] Allow "+remote:local" refspec to cause --force when fetching.
425---
426 + [mhf] Allow "+remote:local" refspec to cause --force when fetching.
427 + [mhf~1] Use git-octopus when pulling more than one heads.
428 + [fixes] Introduce "reset type" flag to "git reset"
429 + [mhf~2] "git fetch --force".
430 + [mhf~3] Use .git/remote/origin, not .git/branches/origin.
431 + [mhf~4] Make "git pull" and "git fetch" default to origin
432 + [mhf~5] Infamous 'octopus merge'
433 + [mhf~6] Retire git-parse-remote.
434 + [mhf~7] Multi-head fetch.
435 + [mhf~8] Start adding the $GIT_DIR/remotes/ support.
Junio C Hamano38064d52006-01-15 10:13:49436*++ [master] Add 'git show-branch'.</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23437</div></div>
438<p>These three branches all forked from a common commit, [master],
439whose commit message is "Add <em>git show-branch</em>. "fixes" branch
440adds one commit <em>Introduce "reset type"</em>. "mhf" branch has many
Junio C Hamano38064d52006-01-15 10:13:49441other commits. The current branch is "master".</p>
442</div>
443<h2>EXAMPLE</h2>
444<div class="sectionbody">
445<p>If you keep your primary branches immediately under
446<tt>$GIT_DIR/refs/heads</tt>, and topic branches in subdirectories of
447it, having the following in the configuration file may help:</p>
448<div class="listingblock">
449<div class="content">
450<pre><tt>[showbranch]
451 default = --topo-order
452 default = heads/*
453</tt></pre>
454</div></div>
455<p>With this,<tt>git show-branch</tt> without extra parameters would show
456only the primary branches. In addition, if you happen to be on
457your topic branch, it is shown as well.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23458</div>
459<h2>Author</h2>
460<div class="sectionbody">
461<p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>
462</div>
463<h2>Documentation</h2>
464<div class="sectionbody">
465<p>Documentation by Junio C Hamano.</p>
466</div>
467<h2>GIT</h2>
468<div class="sectionbody">
469<p>Part of the <a href="git.html">git(7)</a> suite</p>
470</div>
471<div id="footer">
472<div id="footer-text">
Junio C Hamano38064d52006-01-15 10:13:49473Last updated 15-Jan-2006 02:13:29 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23474</div>
475</div>
476</body>
477</html>