blob: 83f07fa663f793d5237c03b6d517c8c0f577c525 [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" />
Junio C Hamano7bd050f2011-09-22 06:32:226<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano103b5722011-01-31 05:03:457<title>git-bisect(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:238<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:3120a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:2327
28em {
29 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:4530 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:2331}
32
33strong {
34 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:4535 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:2336}
37
38tt {
39 color: navy;
40}
41
42h1, 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;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:3150h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:2351 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:2354 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:3156h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:2362
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano103b5722011-01-31 05:03:4577ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano1a4e8412005-12-27 08:17:2381pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:3190 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:2391}
92span#email {
93}
Junio C Hamano103b5722011-01-31 05:03:4594span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:2395 font-family: sans-serif;
96}
97
98div#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;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano103b5722011-01-31 05:03:45114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano1a4e8412005-12-27 08:17:23118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22121 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45137 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano1a4e8412005-12-27 08:17:23176}
Junio C Hamano7bd050f2011-09-22 06:32:22177
Junio C Hamano103b5722011-01-31 05:03:45178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23180 text-align: right;
181}
Junio C Hamano103b5722011-01-31 05:03:45182
Junio C Hamano103b5722011-01-31 05:03:45183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano1a4e8412005-12-27 08:17:23194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22205 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23211}
212
Junio C Hamano1a4e8412005-12-27 08:17:23213div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23214span.image img { border-style: none; }
Junio C Hamano103b5722011-01-31 05:03:45215a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45224 font-style: normal;
225 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23226}
227dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45228 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano103b5722011-01-31 05:03:45234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23238 list-style-type: lower-alpha;
239}
Junio C Hamano103b5722011-01-31 05:03:45240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano1a4e8412005-12-27 08:17:23256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31258 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23259}
Junio C Hamano7bd050f2011-09-22 06:32:22260thead, p.table.header {
Junio C Hamano1a4e8412005-12-27 08:17:23261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano103b5722011-01-31 05:03:45267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano1a4e8412005-12-27 08:17:23285
Junio C Hamano103b5722011-01-31 05:03:45286
287div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano103b5722011-01-31 05:03:45291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31293}
Junio C Hamano103b5722011-01-31 05:03:45294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23298 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45299 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23300 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45301 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23302}
Junio C Hamano103b5722011-01-31 05:03:45303td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23304 vertical-align: top;
305}
Junio C Hamano103b5722011-01-31 05:03:45306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano1a4e8412005-12-27 08:17:23314
Junio C Hamano7bd050f2011-09-22 06:32:22315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano1a4e8412005-12-27 08:17:23343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31346
Junio C Hamano7bd050f2011-09-22 06:32:22347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano103b5722011-01-31 05:03:45376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano1a4e8412005-12-27 08:17:23394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano103b5722011-01-31 05:03:45402 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano103b5722011-01-31 05:03:45415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano1a4e8412005-12-27 08:17:23426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22429 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano1a4e8412005-12-27 08:17:23569</head>
570<body>
571<div id="header">
572<h1>
573git-bisect(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-bisect -
Junio C Hamanofd83b8e2009-03-22 08:21:41578 Find by binary search the change that introduced a bug
Junio C Hamano1a4e8412005-12-27 08:17:23579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22582<div id="content">
Junio C Hamano103b5722011-01-31 05:03:45583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23584<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59585<div class="verseblock">
586<div class="verseblock-content"><em>git bisect</em> &lt;subcommand&gt; &lt;options&gt;</div>
587<div class="verseblock-attribution">
588</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23589</div>
Junio C Hamanoba4b9282008-07-06 05:20:31590<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23591<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45592<div class="paragraph"><p>The command takes various subcommands, and different options depending
Junio C Hamanoba4b9282008-07-06 05:20:31593on the subcommand:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23594<div class="literalblock">
595<div class="content">
Junio C Hamanoe79159d2008-04-12 08:23:17596<pre><tt>git bisect help
Junio C Hamanof7279012011-08-18 06:13:13597git bisect start [--no-checkout] [&lt;bad&gt; [&lt;good&gt;...]] [--] [&lt;paths&gt;...]
Junio C Hamano1974bf22007-10-31 05:57:20598git bisect bad [&lt;rev&gt;]
599git bisect good [&lt;rev&gt;...]
Junio C Hamanod796cea2008-12-03 03:51:10600git bisect skip [(&lt;rev&gt;|&lt;range&gt;)...]
Junio C Hamanoc21ab052009-10-31 04:03:55601git bisect reset [&lt;commit&gt;]
Junio C Hamano1a4e8412005-12-27 08:17:23602git bisect visualize
603git bisect replay &lt;logfile&gt;
Junio C Hamanof440a232007-03-23 10:46:17604git bisect log
605git bisect run &lt;cmd&gt;...</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23606</div></div>
Junio C Hamano103b5722011-01-31 05:03:45607<div class="paragraph"><p>This command uses <em>git rev-list --bisect</em> to help drive the
Junio C Hamanob60308a2007-03-24 07:16:42608binary search process to find which change introduced a bug, given an
Junio C Hamanoba4b9282008-07-06 05:20:31609old "good" commit object name and a later "bad" commit object name.</p></div>
610<h3 id="_getting_help">Getting help</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45611<div class="paragraph"><p>Use "git bisect" to get a short usage description, and "git bisect
Junio C Hamanoba4b9282008-07-06 05:20:31612help" or "git bisect -h" to get a long usage description.</p></div>
613<h3 id="_basic_bisect_commands_start_bad_good">Basic bisect commands: start, bad, good</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45614<div class="paragraph"><p>Using the Linux kernel tree as an example, basic use of the bisect
Junio C Hamanofd83b8e2009-03-22 08:21:41615command is as follows:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23616<div class="listingblock">
617<div class="content">
618<pre><tt>$ git bisect start
Junio C Hamanob60308a2007-03-24 07:16:42619$ git bisect bad # Current version is bad
620$ git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version
621 # tested that was good</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23622</div></div>
Junio C Hamano103b5722011-01-31 05:03:45623<div class="paragraph"><p>When you have specified at least one bad and one good version, the
Junio C Hamanofd83b8e2009-03-22 08:21:41624command bisects the revision tree and outputs something similar to
625the following:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23626<div class="listingblock">
627<div class="content">
628<pre><tt>Bisecting: 675 revisions left to test after this</tt></pre>
629</div></div>
Junio C Hamano103b5722011-01-31 05:03:45630<div class="paragraph"><p>The state in the middle of the set of revisions is then checked out.
Junio C Hamanofd83b8e2009-03-22 08:21:41631You would now compile that kernel and boot it. If the booted kernel
632works correctly, you would then issue the following command:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23633<div class="listingblock">
634<div class="content">
635<pre><tt>$ git bisect good # this one is good</tt></pre>
636</div></div>
Junio C Hamano103b5722011-01-31 05:03:45637<div class="paragraph"><p>The output of this command would be something similar to the following:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23638<div class="listingblock">
639<div class="content">
640<pre><tt>Bisecting: 337 revisions left to test after this</tt></pre>
641</div></div>
Junio C Hamano103b5722011-01-31 05:03:45642<div class="paragraph"><p>You keep repeating this process, compiling the tree, testing it, and
Junio C Hamanofd83b8e2009-03-22 08:21:41643depending on whether it is good or bad issuing the command "git bisect good"
644or "git bisect bad" to ask for the next bisection.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45645<div class="paragraph"><p>Eventually there will be no more revisions left to bisect, and you
Junio C Hamanofd83b8e2009-03-22 08:21:41646will have been left with the first bad kernel revision in "refs/bisect/bad".</p></div>
Junio C Hamanoba4b9282008-07-06 05:20:31647<h3 id="_bisect_reset">Bisect reset</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45648<div class="paragraph"><p>After a bisect session, to clean up the bisection state and return to
Junio C Hamanoc21ab052009-10-31 04:03:55649the original HEAD, issue the following command:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23650<div class="listingblock">
651<div class="content">
652<pre><tt>$ git bisect reset</tt></pre>
653</div></div>
Junio C Hamano103b5722011-01-31 05:03:45654<div class="paragraph"><p>By default, this will return your tree to the commit that was checked
Junio C Hamanoc21ab052009-10-31 04:03:55655out before <tt>git bisect start</tt>. (A new <tt>git bisect start</tt> will also do
656that, as it cleans up the old bisection state.)</p></div>
Junio C Hamano103b5722011-01-31 05:03:45657<div class="paragraph"><p>With an optional argument, you can return to a different commit
Junio C Hamanoc21ab052009-10-31 04:03:55658instead:</p></div>
659<div class="listingblock">
660<div class="content">
661<pre><tt>$ git bisect reset &lt;commit&gt;</tt></pre>
662</div></div>
Junio C Hamano103b5722011-01-31 05:03:45663<div class="paragraph"><p>For example, <tt>git bisect reset HEAD</tt> will leave you on the current
Junio C Hamanoc21ab052009-10-31 04:03:55664bisection commit and avoid switching commits at all, while <tt>git bisect
665reset bisect/bad</tt> will check out the first bad revision.</p></div>
Junio C Hamanoba4b9282008-07-06 05:20:31666<h3 id="_bisect_visualize">Bisect visualize</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45667<div class="paragraph"><p>To see the currently remaining suspects in <em>gitk</em>, issue the following
Junio C Hamano1de75722009-03-26 08:39:38668command during the bisection process:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23669<div class="listingblock">
670<div class="content">
671<pre><tt>$ git bisect visualize</tt></pre>
672</div></div>
Junio C Hamano103b5722011-01-31 05:03:45673<div class="paragraph"><p><tt>view</tt> may also be used as a synonym for <tt>visualize</tt>.</p></div>
674<div class="paragraph"><p>If the <em>DISPLAY</em> environment variable is not set, <em>git log</em> is used
Junio C Hamanofd83b8e2009-03-22 08:21:41675instead. You can also give command line options such as <tt>-p</tt> and
Junio C Hamanoba4b9282008-07-06 05:20:31676<tt>--stat</tt>.</p></div>
Junio C Hamano942b35e2007-12-09 10:19:33677<div class="listingblock">
678<div class="content">
679<pre><tt>$ git bisect view --stat</tt></pre>
680</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31681<h3 id="_bisect_log_and_bisect_replay">Bisect log and bisect replay</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45682<div class="paragraph"><p>After having marked revisions as good or bad, issue the following
Junio C Hamanofd83b8e2009-03-22 08:21:41683command to show what has been done so far:</p></div>
Junio C Hamanob60308a2007-03-24 07:16:42684<div class="listingblock">
685<div class="content">
686<pre><tt>$ git bisect log</tt></pre>
687</div></div>
Junio C Hamano103b5722011-01-31 05:03:45688<div class="paragraph"><p>If you discover that you made a mistake in specifying the status of a
Junio C Hamanofd83b8e2009-03-22 08:21:41689revision, you can save the output of this command to a file, edit it to
690remove the incorrect entries, and then issue the following commands to
691return to a corrected state:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23692<div class="listingblock">
693<div class="content">
Junio C Hamanofd83b8e2009-03-22 08:21:41694<pre><tt>$ git bisect reset
695$ git bisect replay that-file</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23696</div></div>
Junio C Hamanofd83b8e2009-03-22 08:21:41697<h3 id="_avoiding_testing_a_commit">Avoiding testing a commit</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45698<div class="paragraph"><p>If, in the middle of a bisect session, you know that the next suggested
Junio C Hamanofd83b8e2009-03-22 08:21:41699revision is not a good one to test (e.g. the change the commit
Junio C Hamanob60308a2007-03-24 07:16:42700introduces is known not to work in your environment and you know it
701does not have anything to do with the bug you are chasing), you may
Junio C Hamanofd83b8e2009-03-22 08:21:41702want to find a nearby commit and try that instead.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45703<div class="paragraph"><p>For example:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23704<div class="listingblock">
705<div class="content">
Junio C Hamanofd83b8e2009-03-22 08:21:41706<pre><tt>$ git bisect good/bad # previous round was good or bad.
Junio C Hamano1a4e8412005-12-27 08:17:23707Bisecting: 337 revisions left to test after this
708$ git bisect visualize # oops, that is uninteresting.
Junio C Hamanofd83b8e2009-03-22 08:21:41709$ git reset --hard HEAD~3 # try 3 revisions before what
Junio C Hamano1a4e8412005-12-27 08:17:23710 # was suggested</tt></pre>
711</div></div>
Junio C Hamano103b5722011-01-31 05:03:45712<div class="paragraph"><p>Then compile and test the chosen revision, and afterwards mark
Junio C Hamano1de75722009-03-26 08:39:38713the revision as good or bad in the usual manner.</p></div>
Junio C Hamanoba4b9282008-07-06 05:20:31714<h3 id="_bisect_skip">Bisect skip</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45715<div class="paragraph"><p>Instead of choosing by yourself a nearby commit, you can ask git
Junio C Hamanofd83b8e2009-03-22 08:21:41716to do it for you by issuing the command:</p></div>
Junio C Hamano1974bf22007-10-31 05:57:20717<div class="listingblock">
718<div class="content">
719<pre><tt>$ git bisect skip # Current version cannot be tested</tt></pre>
720</div></div>
Junio C Hamano103b5722011-01-31 05:03:45721<div class="paragraph"><p>But git may eventually be unable to tell the first bad commit among
Junio C Hamano2c14c8d2009-07-02 03:17:00722a bad commit and one or more skipped commits.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45723<div class="paragraph"><p>You can even skip a range of commits, instead of just one commit,
Junio C Hamanod796cea2008-12-03 03:51:10724using the "<em>&lt;commit1&gt;</em>..<em>&lt;commit2&gt;</em>" notation. For example:</p></div>
725<div class="listingblock">
726<div class="content">
727<pre><tt>$ git bisect skip v2.5..v2.6</tt></pre>
728</div></div>
Junio C Hamano103b5722011-01-31 05:03:45729<div class="paragraph"><p>This tells the bisect process that no commit after <tt>v2.5</tt>, up to and
Junio C Hamano1de75722009-03-26 08:39:38730including <tt>v2.6</tt>, should be tested.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45731<div class="paragraph"><p>Note that if you also want to skip the first commit of the range you
Junio C Hamanofd83b8e2009-03-22 08:21:41732would issue the command:</p></div>
Junio C Hamanod796cea2008-12-03 03:51:10733<div class="listingblock">
734<div class="content">
735<pre><tt>$ git bisect skip v2.5 v2.5..v2.6</tt></pre>
736</div></div>
Junio C Hamano103b5722011-01-31 05:03:45737<div class="paragraph"><p>This tells the bisect process that the commits between <tt>v2.5</tt> included
Junio C Hamano1de75722009-03-26 08:39:38738and <tt>v2.6</tt> included should be skipped.</p></div>
Junio C Hamanoba4b9282008-07-06 05:20:31739<h3 id="_cutting_down_bisection_by_giving_more_parameters_to_bisect_start">Cutting down bisection by giving more parameters to bisect start</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45740<div class="paragraph"><p>You can further cut down the number of trials, if you know what part of
Junio C Hamanofd83b8e2009-03-22 08:21:41741the tree is involved in the problem you are tracking down, by specifying
742path parameters when issuing the <tt>bisect start</tt> command:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23743<div class="listingblock">
744<div class="content">
Junio C Hamano12a3a232007-04-07 10:18:10745<pre><tt>$ git bisect start -- arch/i386 include/asm-i386</tt></pre>
746</div></div>
Junio C Hamano103b5722011-01-31 05:03:45747<div class="paragraph"><p>If you know beforehand more than one good commit, you can narrow the
Junio C Hamanofd83b8e2009-03-22 08:21:41748bisect space down by specifying all of the good commits immediately after
749the bad commit when issuing the <tt>bisect start</tt> command:</p></div>
Junio C Hamano12a3a232007-04-07 10:18:10750<div class="listingblock">
751<div class="content">
752<pre><tt>$ git bisect start v2.6.20-rc6 v2.6.20-rc4 v2.6.20-rc1 --
753 # v2.6.20-rc6 is bad
754 # v2.6.20-rc4 and v2.6.20-rc1 are good</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23755</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31756<h3 id="_bisect_run">Bisect run</h3><div style="clear:left"></div>
Junio C Hamano103b5722011-01-31 05:03:45757<div class="paragraph"><p>If you have a script that can tell if the current source code is good
Junio C Hamanofd83b8e2009-03-22 08:21:41758or bad, you can bisect by issuing the command:</p></div>
Junio C Hamanof440a232007-03-23 10:46:17759<div class="listingblock">
760<div class="content">
Junio C Hamano0a235222009-03-06 08:21:09761<pre><tt>$ git bisect run my_script arguments</tt></pre>
Junio C Hamanof440a232007-03-23 10:46:17762</div></div>
Junio C Hamano103b5722011-01-31 05:03:45763<div class="paragraph"><p>Note that the script (<tt>my_script</tt> in the above example) should
Junio C Hamanofd83b8e2009-03-22 08:21:41764exit with code 0 if the current source code is good, and exit with a
Junio C Hamano1974bf22007-10-31 05:57:20765code between 1 and 127 (inclusive), except 125, if the current
Junio C Hamanoba4b9282008-07-06 05:20:31766source code is bad.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45767<div class="paragraph"><p>Any other exit code will abort the bisect process. It should be noted
Junio C Hamanofd83b8e2009-03-22 08:21:41768that a program that terminates via "exit(-1)" leaves $? = 255, (see the
769exit(3) manual page), as the value is chopped with "&amp; 0377".</p></div>
Junio C Hamano103b5722011-01-31 05:03:45770<div class="paragraph"><p>The special exit code 125 should be used when the current source code
Junio C Hamanofd83b8e2009-03-22 08:21:41771cannot be tested. If the script exits with this code, the current
Junio C Hamanod2c978f2011-03-20 19:42:22772revision will be skipped (see <tt>git bisect skip</tt> above). 125 was chosen
773as the highest sensible value to use for this purpose, because 126 and 127
774are used by POSIX shells to signal specific error status (127 is for
775command not found, 126 is for command found but not executable---these
776details do not matter, as they are normal errors in the script, as far as
777"bisect run" is concerned).</p></div>
Junio C Hamano103b5722011-01-31 05:03:45778<div class="paragraph"><p>You may often find that during a bisect session you want to have
Junio C Hamanofd83b8e2009-03-22 08:21:41779temporary modifications (e.g. s/#define DEBUG 0/#define DEBUG 1/ in a
780header file, or "revision that does not have this commit needs this
781patch applied to work around another problem this bisection is not
782interested in") applied to the revision being tested.</p></div>
Junio C Hamano103b5722011-01-31 05:03:45783<div class="paragraph"><p>To cope with such a situation, after the inner <em>git bisect</em> finds the
Junio C Hamanofd83b8e2009-03-22 08:21:41784next revision to test, the script can apply the patch
785before compiling, run the real test, and afterwards decide if the
786revision (possibly with the needed patch) passed the test and then
787rewind the tree to the pristine state. Finally the script should exit
788with the status of the real test to let the "git bisect run" command loop
789determine the eventual outcome of the bisect session.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23790</div>
Junio C Hamanof7279012011-08-18 06:13:13791<h2 id="_options">OPTIONS</h2>
792<div class="sectionbody">
793<div class="dlist"><dl>
794<dt class="hdlist1">
795--no-checkout
796</dt>
797<dd>
798<div class="paragraph"><p>Do not checkout the new working tree at each iteration of the bisection
799process. Instead just update a special reference named <em>BISECT_HEAD</em> to make
800it point to the commit that should be tested.</p></div>
801<div class="paragraph"><p>This option may be useful when the test you would perform in each step
802does not require a checked out tree.</p></div>
803<div class="paragraph"><p>If the repository is bare, <tt>--no-checkout</tt> is assumed.</p></div>
804</dd>
805</dl></div>
806</div>
Junio C Hamanoba4b9282008-07-06 05:20:31807<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano6d76d612008-05-09 05:46:08808<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45809<div class="ulist"><ul>
Junio C Hamano6d76d612008-05-09 05:46:08810<li>
811<p>
812Automatically bisect a broken build between v1.2 and HEAD:
813</p>
814<div class="listingblock">
815<div class="content">
816<pre><tt>$ git bisect start HEAD v1.2 -- # HEAD is bad, v1.2 is good
817$ git bisect run make # "make" builds the app</tt></pre>
818</div></div>
819</li>
820<li>
821<p>
Junio C Hamano0a235222009-03-06 08:21:09822Automatically bisect a test failure between origin and HEAD:
823</p>
824<div class="listingblock">
825<div class="content">
826<pre><tt>$ git bisect start HEAD origin -- # HEAD is bad, origin is good
827$ git bisect run make test # "make test" builds and tests</tt></pre>
828</div></div>
829</li>
830<li>
831<p>
Junio C Hamano6d76d612008-05-09 05:46:08832Automatically bisect a broken test case:
833</p>
834<div class="listingblock">
835<div class="content">
836<pre><tt>$ cat ~/test.sh
837#!/bin/sh
Junio C Hamanofd83b8e2009-03-22 08:21:41838make || exit 125 # this skips broken builds
Junio C Hamano9a2fb2d2011-03-23 05:40:15839~/check_test_case.sh # does the test case pass?
Junio C Hamano6d76d612008-05-09 05:46:08840$ git bisect start HEAD HEAD~10 -- # culprit is among the last 10
841$ git bisect run ~/test.sh</tt></pre>
842</div></div>
Junio C Hamano9a2fb2d2011-03-23 05:40:15843<div class="paragraph"><p>Here we use a "test.sh" custom script. In this script, if "make"
844fails, we skip the current commit.
845"check_test_case.sh" should "exit 0" if the test case passes,
Junio C Hamanofd83b8e2009-03-22 08:21:41846and "exit 1" otherwise.</p></div>
Junio C Hamano9a2fb2d2011-03-23 05:40:15847<div class="paragraph"><p>It is safer if both "test.sh" and "check_test_case.sh" are
Junio C Hamanofd83b8e2009-03-22 08:21:41848outside the repository to prevent interactions between the bisect,
849make and test processes and the scripts.</p></div>
Junio C Hamano6d76d612008-05-09 05:46:08850</li>
Junio C Hamano0a235222009-03-06 08:21:09851<li>
852<p>
Junio C Hamano9a2fb2d2011-03-23 05:40:15853Automatically bisect with temporary modifications (hot-fix):
854</p>
855<div class="listingblock">
856<div class="content">
857<pre><tt>$ cat ~/test.sh
858#!/bin/sh
859
860# tweak the working tree by merging the hot-fix branch
861# and then attempt a build
862if git merge --no-commit hot-fix &amp;&amp;
863 make
864then
865 # run project specific test and report its status
866 ~/check_test_case.sh
867 status=$?
868else
869 # tell the caller this is untestable
870 status=125
871fi
872
873# undo the tweak to allow clean flipping to the next commit
874git reset --hard
875
876# return control
877exit $status</tt></pre>
878</div></div>
879<div class="paragraph"><p>This applies modifications from a hot-fix branch before each test run,
880e.g. in case your build or test environment changed so that older
881revisions may need a fix which newer ones have already. (Make sure the
882hot-fix branch is based off a commit which is contained in all revisions
883which you are bisecting, so that the merge does not pull in too much, or
884use <tt>git cherry-pick</tt> instead of <tt>git merge</tt>.)</p></div>
885</li>
886<li>
887<p>
888Automatically bisect a broken test case:
Junio C Hamano0a235222009-03-06 08:21:09889</p>
890<div class="listingblock">
891<div class="content">
892<pre><tt>$ git bisect start HEAD HEAD~10 -- # culprit is among the last 10
893$ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"</tt></pre>
894</div></div>
Junio C Hamano9a2fb2d2011-03-23 05:40:15895<div class="paragraph"><p>This shows that you can do without a run script if you write the test
896on a single line.</p></div>
Junio C Hamano0a235222009-03-06 08:21:09897</li>
Junio C Hamanof7279012011-08-18 06:13:13898<li>
899<p>
900Locate a good region of the object graph in a damaged repository
901</p>
902<div class="listingblock">
903<div class="content">
904<pre><tt>$ git bisect start HEAD &lt;known-good-commit&gt; [ &lt;boundary-commit&gt; ... ] --no-checkout
905$ git bisect run sh -c '
906 GOOD=$(git for-each-ref "--format=%(objectname)" refs/bisect/good-*) &amp;&amp;
907 git rev-list --objects BISECT_HEAD --not $GOOD &gt;tmp.$$ &amp;&amp;
908 git pack-objects --stdout &gt;/dev/null &lt;tmp.$$
909 rc=$?
910 rm -f tmp.$$
911 test $rc = 0'</tt></pre>
912</div></div>
913<div class="paragraph"><p>In this case, when <em>git bisect run</em> finishes, bisect/bad will refer to a commit that
914has at least one parent whose reachable graph is fully traversable in the sense
915required by <em>git pack objects</em>.</p></div>
916</li>
Junio C Hamanoba4b9282008-07-06 05:20:31917</ul></div>
Junio C Hamano6d76d612008-05-09 05:46:08918</div>
Junio C Hamano2bd8a742009-12-01 21:16:59919<h2 id="_see_also">SEE ALSO</h2>
920<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45921<div class="paragraph"><p><a href="git-bisect-lk2009.html">Fighting regressions with git bisect</a>,
Junio C Hamano2bd8a742009-12-01 21:16:59922<a href="git-blame.html">git-blame(1)</a>.</p></div>
923</div>
Junio C Hamanoba4b9282008-07-06 05:20:31924<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23925<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45926<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23927</div>
Junio C Hamano7bd050f2011-09-22 06:32:22928</div>
929<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23930<div id="footer">
931<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59932Last updated 2011-11-15 13:45:02 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23933</div>
934</div>
935</body>
936</html>