| blob | bfc3b7f847ed6a1a746d2c421df989e88f12fb71 |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-bisect(1) Manual Page
407 </h1>
410 <p>git-bisect -
411 Find by binary search the change that introduced a bug
412 </p>
413 </div>
414 </div>
418 </div>
421 <div class="paragraph"><p>The command takes various subcommands, and different options depending
422 on the subcommand:</p></div>
425 <pre><tt>git bisect help
431 git bisect visualize
433 git bisect log
435 </div></div>
437 binary search process to find which change introduced a bug, given an
442 <h3 id="_basic_bisect_commands_start_bad_good">Basic bisect commands: start, bad, good</h3><div style="clear:left"></div>
444 command is as follows:</p></div>
447 <pre><tt>$ git bisect start
448 $ git bisect bad # Current version is bad
450 # tested that was good</tt></pre>
451 </div></div>
453 command bisects the revision tree and outputs something similar to
454 the following:</p></div>
458 </div></div>
460 You would now compile that kernel and boot it. If the booted kernel
461 works correctly, you would then issue the following command:</p></div>
465 </div></div>
466 <div class="paragraph"><p>The output of this command would be something similar to the following:</p></div>
470 </div></div>
472 depending on whether it is good or bad issuing the command "git bisect good"
478 the original HEAD, issue the following command:</p></div>
482 </div></div>
485 that, as it cleans up the old bisection state.)</p></div>
487 instead:</p></div>
491 </div></div>
492 <div class="paragraph"><p>For example, <tt>git bisect reset HEAD</tt> will leave you on the current
493 bisection commit and avoid switching commits at all, while <tt>git bisect
496 <div class="paragraph"><p>To see the currently remaining suspects in <em>gitk</em>, issue the following
497 command during the bisection process:</p></div>
501 </div></div>
502 <div class="paragraph"><p><tt>view</tt> may also be used as a synonym for <tt>visualize</tt>.</p></div>
503 <div class="paragraph"><p>If the <em>DISPLAY</em> environment variable is not set, <em>git log</em> is used
509 </div></div>
510 <h3 id="_bisect_log_and_bisect_replay">Bisect log and bisect replay</h3><div style="clear:left"></div>
512 command to show what has been done so far:</p></div>
516 </div></div>
518 revision, you can save the output of this command to a file, edit it to
519 remove the incorrect entries, and then issue the following commands to
520 return to a corrected state:</p></div>
523 <pre><tt>$ git bisect reset
524 $ git bisect replay that-file</tt></pre>
525 </div></div>
526 <h3 id="_avoiding_testing_a_commit">Avoiding testing a commit</h3><div style="clear:left"></div>
527 <div class="paragraph"><p>If, in the middle of a bisect session, you know that the next suggested
528 revision is not a good one to test (e.g. the change the commit
529 introduces is known not to work in your environment and you know it
530 does not have anything to do with the bug you are chasing), you may
531 want to find a nearby commit and try that instead.</p></div>
535 <pre><tt>$ git bisect good/bad # previous round was good or bad.
536 Bisecting: 337 revisions left to test after this
537 $ git bisect visualize # oops, that is uninteresting.
539 # was suggested</tt></pre>
540 </div></div>
542 the revision as good or bad in the usual manner.</p></div>
545 to do it for you by issuing the command:</p></div>
549 </div></div>
551 a bad commit and one or more skipped commits.</p></div>
557 </div></div>
558 <div class="paragraph"><p>This tells the bisect process that no commit after <tt>v2.5</tt>, up to and
561 would issue the command:</p></div>
565 </div></div>
566 <div class="paragraph"><p>This tells the bisect process that the commits between <tt>v2.5</tt> included
568 <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>
569 <div class="paragraph"><p>You can further cut down the number of trials, if you know what part of
570 the tree is involved in the problem you are tracking down, by specifying
575 </div></div>
577 bisect space down by specifying all of the good commits immediately after
582 # v2.6.20-rc6 is bad
584 </div></div>
587 or bad, you can bisect by issuing the command:</p></div>
591 </div></div>
593 exit with code 0 if the current source code is good, and exit with a
595 source code is bad.</p></div>
600 cannot be tested. If the script exits with this code, the current
603 are used by POSIX shells to signal specific error status (127 is for
604 command not found, 126 is for command found but not executable---these
605 details do not matter, as they are normal errors in the script, as far as
609 header file, or "revision that does not have this commit needs this
610 patch applied to work around another problem this bisection is not
612 <div class="paragraph"><p>To cope with such a situation, after the inner <em>git bisect</em> finds the
613 next revision to test, the script can apply the patch
614 before compiling, run the real test, and afterwards decide if the
615 revision (possibly with the needed patch) passed the test and then
616 rewind the tree to the pristine state. Finally the script should exit
617 with the status of the real test to let the "git bisect run" command loop
618 determine the eventual outcome of the bisect session.</p></div>
619 </div>
623 <li>
624 <p>
625 Automatically bisect a broken build between v1.2 and HEAD:
626 </p>
629 <pre><tt>$ git bisect start HEAD v1.2 -- # HEAD is bad, v1.2 is good
631 </div></div>
632 </li>
633 <li>
634 <p>
635 Automatically bisect a test failure between origin and HEAD:
636 </p>
639 <pre><tt>$ git bisect start HEAD origin -- # HEAD is bad, origin is good
641 </div></div>
642 </li>
643 <li>
644 <p>
645 Automatically bisect a broken test case:
646 </p>
649 <pre><tt>$ cat ~/test.sh
650 #!/bin/sh
651 make || exit 125 # this skips broken builds
652 ~/check_test_case.sh # does the test case pass?
654 $ git bisect run ~/test.sh</tt></pre>
655 </div></div>
657 fails, we skip the current commit.
661 outside the repository to prevent interactions between the bisect,
662 make and test processes and the scripts.</p></div>
663 </li>
664 <li>
665 <p>
666 Automatically bisect with temporary modifications (hot-fix):
667 </p>
670 <pre><tt>$ cat ~/test.sh
671 #!/bin/sh
673 # tweak the working tree by merging the hot-fix branch
674 # and then attempt a build
675 if git merge --no-commit hot-fix &&
676 make
677 then
678 # run project specific test and report its status
679 ~/check_test_case.sh
680 status=$?
681 else
682 # tell the caller this is untestable
683 status=125
684 fi
686 # undo the tweak to allow clean flipping to the next commit
687 git reset --hard
689 # return control
690 exit $status</tt></pre>
691 </div></div>
692 <div class="paragraph"><p>This applies modifications from a hot-fix branch before each test run,
693 e.g. in case your build or test environment changed so that older
694 revisions may need a fix which newer ones have already. (Make sure the
695 hot-fix branch is based off a commit which is contained in all revisions
696 which you are bisecting, so that the merge does not pull in too much, or
698 </li>
699 <li>
700 <p>
701 Automatically bisect a broken test case:
702 </p>
707 </div></div>
709 on a single line.</p></div>
710 </li>
711 </ul></div>
712 </div>
715 <div class="paragraph"><p><a href="git-bisect-lk2009.html">Fighting regressions with git bisect</a>,
717 </div>
721 </div>
725 </div>
726 </div>
727 </body>
728 </html>