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