| blob | 93bafeeddc80e8e1df36a02b62ea51d15b989500 |
4 <head>
8 /* Debug borders */
10 /*
11 border: 1px solid red;
12 */
13 }
15 body {
17 }
19 a {
22 }
25 }
27 em {
29 }
31 strong {
33 }
35 tt {
37 }
45 }
49 }
50 h2 {
52 }
53 h3 {
55 }
56 h3 + * {
58 }
63 }
65 hr {
67 }
69 p {
72 }
74 pre {
77 }
79 span#author {
84 }
85 span#email {
86 }
87 span#revision {
89 }
91 div#footer {
97 }
98 div#footer-text {
101 }
102 div#footer-badges {
105 }
107 div#preamble,
114 }
118 }
122 }
124 /* Block element titles. */
131 }
134 }
138 }
141 }
144 }
150 }
154 }
159 }
163 }
167 }
170 }
179 }
183 }
188 }
192 }
198 dl {
201 }
202 dt {
206 }
209 }
213 }
216 }
220 }
221 thead {
224 }
225 tfoot {
227 }
232 }
235 }
240 }
243 }
247 }
249 div#toctitle {
256 }
261 }
265 }
269 }
273 }
275 /* Workarounds for IE6's broken and incomplete CSS2. */
281 }
287 }
293 }
297 }
302 }
304 /* IE6 sets dynamically generated links as visited. */
306 </style>
308 </head>
309 <body>
311 <h1>
312 git-bisect(1) Manual Page
313 </h1>
316 <p>git-bisect -
317 Find by binary search the change that introduced a bug
318 </p>
319 </div>
320 </div>
324 </div>
328 on the subcommand:</p></div>
331 <pre><tt>git bisect help
337 git bisect visualize
339 git bisect log
341 </div></div>
343 binary search process to find which change introduced a bug, given an
348 <h3 id="_basic_bisect_commands_start_bad_good">Basic bisect commands: start, bad, good</h3><div style="clear:left"></div>
350 command is as follows:</p></div>
353 <pre><tt>$ git bisect start
354 $ git bisect bad # Current version is bad
356 # tested that was good</tt></pre>
357 </div></div>
359 command bisects the revision tree and outputs something similar to
360 the following:</p></div>
364 </div></div>
366 You would now compile that kernel and boot it. If the booted kernel
367 works correctly, you would then issue the following command:</p></div>
371 </div></div>
372 <div class="para"><p>The output of this command would be something similar to the following:</p></div>
376 </div></div>
378 depending on whether it is good or bad issuing the command "git bisect good"
384 the original HEAD, issue the following command:</p></div>
388 </div></div>
391 that, as it cleans up the old bisection state.)</p></div>
393 instead:</p></div>
397 </div></div>
399 bisection commit and avoid switching commits at all, while <tt>git bisect
402 <div class="para"><p>To see the currently remaining suspects in <em>gitk</em>, issue the following
403 command during the bisection process:</p></div>
407 </div></div>
408 <div class="para"><p><tt>view</tt> may also be used as a synonym for <tt>visualize</tt>.</p></div>
409 <div class="para"><p>If the <em>DISPLAY</em> environment variable is not set, <em>git log</em> is used
415 </div></div>
416 <h3 id="_bisect_log_and_bisect_replay">Bisect log and bisect replay</h3><div style="clear:left"></div>
418 command to show what has been done so far:</p></div>
422 </div></div>
424 revision, you can save the output of this command to a file, edit it to
425 remove the incorrect entries, and then issue the following commands to
426 return to a corrected state:</p></div>
429 <pre><tt>$ git bisect reset
430 $ git bisect replay that-file</tt></pre>
431 </div></div>
432 <h3 id="_avoiding_testing_a_commit">Avoiding testing a commit</h3><div style="clear:left"></div>
434 revision is not a good one to test (e.g. the change the commit
435 introduces is known not to work in your environment and you know it
436 does not have anything to do with the bug you are chasing), you may
437 want to find a nearby commit and try that instead.</p></div>
441 <pre><tt>$ git bisect good/bad # previous round was good or bad.
442 Bisecting: 337 revisions left to test after this
443 $ git bisect visualize # oops, that is uninteresting.
445 # was suggested</tt></pre>
446 </div></div>
448 the revision as good or bad in the usual manner.</p></div>
451 to do it for you by issuing the command:</p></div>
455 </div></div>
457 a bad commit and one or more skipped commits.</p></div>
463 </div></div>
464 <div class="para"><p>This tells the bisect process that no commit after <tt>v2.5</tt>, up to and
467 would issue the command:</p></div>
471 </div></div>
472 <div class="para"><p>This tells the bisect process that the commits between <tt>v2.5</tt> included
474 <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>
476 the tree is involved in the problem you are tracking down, by specifying
481 </div></div>
483 bisect space down by specifying all of the good commits immediately after
488 # v2.6.20-rc6 is bad
490 </div></div>
493 or bad, you can bisect by issuing the command:</p></div>
497 </div></div>
499 exit with code 0 if the current source code is good, and exit with a
501 source code is bad.</p></div>
506 cannot be tested. If the script exits with this code, the current
510 header file, or "revision that does not have this commit needs this
511 patch applied to work around another problem this bisection is not
513 <div class="para"><p>To cope with such a situation, after the inner <em>git bisect</em> finds the
514 next revision to test, the script can apply the patch
515 before compiling, run the real test, and afterwards decide if the
516 revision (possibly with the needed patch) passed the test and then
517 rewind the tree to the pristine state. Finally the script should exit
518 with the status of the real test to let the "git bisect run" command loop
519 determine the eventual outcome of the bisect session.</p></div>
520 </div>
524 <li>
525 <p>
526 Automatically bisect a broken build between v1.2 and HEAD:
527 </p>
530 <pre><tt>$ git bisect start HEAD v1.2 -- # HEAD is bad, v1.2 is good
532 </div></div>
533 </li>
534 <li>
535 <p>
536 Automatically bisect a test failure between origin and HEAD:
537 </p>
540 <pre><tt>$ git bisect start HEAD origin -- # HEAD is bad, origin is good
542 </div></div>
543 </li>
544 <li>
545 <p>
546 Automatically bisect a broken test suite:
547 </p>
550 <pre><tt>$ cat ~/test.sh
551 #!/bin/sh
552 make || exit 125 # this skips broken builds
553 make test # "make test" runs the test suite
554 $ git bisect start v1.3 v1.1 -- # v1.3 is bad, v1.1 is good
555 $ git bisect run ~/test.sh</tt></pre>
556 </div></div>
558 fails, we skip the current commit.</p></div>
560 interactions between the bisect, make and test processes and the
561 script.</p></div>
564 </li>
565 <li>
566 <p>
567 Automatically bisect a broken test case:
568 </p>
571 <pre><tt>$ cat ~/test.sh
572 #!/bin/sh
573 make || exit 125 # this skips broken builds
574 ~/check_test_case.sh # does the test case passes ?
576 $ git bisect run ~/test.sh</tt></pre>
577 </div></div>
581 outside the repository to prevent interactions between the bisect,
582 make and test processes and the scripts.</p></div>
583 </li>
584 <li>
585 <p>
586 Automatically bisect a broken test suite:
587 </p>
592 </div></div>
594 </li>
595 </ul></div>
596 </div>
600 </div>
603 <div class="para"><p>Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.</p></div>
604 </div>
609 </div>
613 </div>
617 </div>
618 </div>
619 </body>
620 </html>