Autogenerated manpages for v2.36.1-153-gf9b95
[git-manpages.git] / man1 / git-bisect.1
blobf0c2043087acd8ac02177386e5528f0b1a65f198
1 '\" t
2 .\"     Title: git-bisect
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 05/20/2022
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.36.1.153.gf9b95943b6
8 .\"  Language: English
9 .\"
10 .TH "GIT\-BISECT" "1" "05/20/2022" "Git 2\&.36\&.1\&.153\&.gf9b959" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-bisect \- Use binary search to find the commit that introduced a bug
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit bisect\fR <subcommand> <options>
36 .fi
37 .sp
38 .SH "DESCRIPTION"
39 .sp
40 The command takes various subcommands, and different options depending on the subcommand:
41 .sp
42 .if n \{\
43 .RS 4
44 .\}
45 .nf
46 git bisect start [\-\-term\-{new,bad}=<term> \-\-term\-{old,good}=<term>]
47                  [\-\-no\-checkout] [\-\-first\-parent] [<bad> [<good>\&.\&.\&.]] [\-\-] [<paths>\&.\&.\&.]
48 git bisect (bad|new|<term\-new>) [<rev>]
49 git bisect (good|old|<term\-old>) [<rev>\&.\&.\&.]
50 git bisect terms [\-\-term\-good | \-\-term\-bad]
51 git bisect skip [(<rev>|<range>)\&.\&.\&.]
52 git bisect reset [<commit>]
53 git bisect (visualize|view)
54 git bisect replay <logfile>
55 git bisect log
56 git bisect run <cmd>\&.\&.\&.
57 git bisect help
58 .fi
59 .if n \{\
60 .RE
61 .\}
62 .sp
63 This command uses a binary search algorithm to find which commit in your project\(cqs history introduced a bug\&. You use it by first telling it a "bad" commit that is known to contain the bug, and a "good" commit that is known to be before the bug was introduced\&. Then \fBgit bisect\fR picks a commit between those two endpoints and asks you whether the selected commit is "good" or "bad"\&. It continues narrowing down the range until it finds the exact commit that introduced the change\&.
64 .sp
65 In fact, \fBgit bisect\fR can be used to find the commit that changed \fBany\fR property of your project; e\&.g\&., the commit that fixed a bug, or the commit that caused a benchmark\(cqs performance to improve\&. To support this more general usage, the terms "old" and "new" can be used in place of "good" and "bad", or you can choose your own terms\&. See section "Alternate terms" below for more information\&.
66 .SS "Basic bisect commands: start, bad, good"
67 .sp
68 As an example, suppose you are trying to find the commit that broke a feature that was known to work in version \fBv2\&.6\&.13\-rc2\fR of your project\&. You start a bisect session as follows:
69 .sp
70 .if n \{\
71 .RS 4
72 .\}
73 .nf
74 $ git bisect start
75 $ git bisect bad                 # Current version is bad
76 $ git bisect good v2\&.6\&.13\-rc2    # v2\&.6\&.13\-rc2 is known to be good
77 .fi
78 .if n \{\
79 .RE
80 .\}
81 .sp
82 .sp
83 Once you have specified at least one bad and one good commit, \fBgit bisect\fR selects a commit in the middle of that range of history, checks it out, and outputs something similar to the following:
84 .sp
85 .if n \{\
86 .RS 4
87 .\}
88 .nf
89 Bisecting: 675 revisions left to test after this (roughly 10 steps)
90 .fi
91 .if n \{\
92 .RE
93 .\}
94 .sp
95 .sp
96 You should now compile the checked\-out version and test it\&. If that version works correctly, type
97 .sp
98 .if n \{\
99 .RS 4
102 $ git bisect good
104 .if n \{\
109 If that version is broken, type
111 .if n \{\
112 .RS 4
115 $ git bisect bad
117 .if n \{\
122 Then \fBgit bisect\fR will respond with something like
124 .if n \{\
125 .RS 4
128 Bisecting: 337 revisions left to test after this (roughly 9 steps)
130 .if n \{\
135 Keep repeating the process: compile the tree, test it, and depending on whether it is good or bad run \fBgit bisect good\fR or \fBgit bisect bad\fR to ask for the next commit that needs testing\&.
137 Eventually there will be no more revisions left to inspect, and the command will print out a description of the first bad commit\&. The reference \fBrefs/bisect/bad\fR will be left pointing at that commit\&.
138 .SS "Bisect reset"
140 After a bisect session, to clean up the bisection state and return to the original HEAD, issue the following command:
142 .if n \{\
143 .RS 4
146 $ git bisect reset
148 .if n \{\
153 By default, this will return your tree to the commit that was checked out before \fBgit bisect start\fR\&. (A new \fBgit bisect start\fR will also do that, as it cleans up the old bisection state\&.)
155 With an optional argument, you can return to a different commit instead:
157 .if n \{\
158 .RS 4
161 $ git bisect reset <commit>
163 .if n \{\
168 For example, \fBgit bisect reset bisect/bad\fR will check out the first bad revision, while \fBgit bisect reset HEAD\fR will leave you on the current bisection commit and avoid switching commits at all\&.
169 .SS "Alternate terms"
171 Sometimes you are not looking for the commit that introduced a breakage, but rather for a commit that caused a change between some other "old" state and "new" state\&. For example, you might be looking for the commit that introduced a particular fix\&. Or you might be looking for the first commit in which the source\-code filenames were finally all converted to your company\(cqs naming standard\&. Or whatever\&.
173 In such cases it can be very confusing to use the terms "good" and "bad" to refer to "the state before the change" and "the state after the change"\&. So instead, you can use the terms "old" and "new", respectively, in place of "good" and "bad"\&. (But note that you cannot mix "good" and "bad" with "old" and "new" in a single session\&.)
175 In this more general usage, you provide \fBgit bisect\fR with a "new" commit that has some property and an "old" commit that doesn\(cqt have that property\&. Each time \fBgit bisect\fR checks out a commit, you test if that commit has the property\&. If it does, mark the commit as "new"; otherwise, mark it as "old"\&. When the bisection is done, \fBgit bisect\fR will report which commit introduced the property\&.
177 To use "old" and "new" instead of "good" and bad, you must run \fBgit bisect start\fR without commits as argument and then run the following commands to add the commits:
179 .if n \{\
180 .RS 4
183 git bisect old [<rev>]
185 .if n \{\
190 to indicate that a commit was before the sought change, or
192 .if n \{\
193 .RS 4
196 git bisect new [<rev>\&.\&.\&.]
198 .if n \{\
203 to indicate that it was after\&.
205 To get a reminder of the currently used terms, use
207 .if n \{\
208 .RS 4
211 git bisect terms
213 .if n \{\
218 You can get just the old (respectively new) term with \fBgit bisect terms \-\-term\-old\fR or \fBgit bisect terms \-\-term\-good\fR\&.
220 If you would like to use your own terms instead of "bad"/"good" or "new"/"old", you can choose any names you like (except existing bisect subcommands like \fBreset\fR, \fBstart\fR, \&...) by starting the bisection using
222 .if n \{\
223 .RS 4
226 git bisect start \-\-term\-old <term\-old> \-\-term\-new <term\-new>
228 .if n \{\
233 For example, if you are looking for a commit that introduced a performance regression, you might use
235 .if n \{\
236 .RS 4
239 git bisect start \-\-term\-old fast \-\-term\-new slow
241 .if n \{\
246 Or if you are looking for the commit that fixed a bug, you might use
248 .if n \{\
249 .RS 4
252 git bisect start \-\-term\-new fixed \-\-term\-old broken
254 .if n \{\
259 Then, use \fBgit bisect <term\-old>\fR and \fBgit bisect <term\-new>\fR instead of \fBgit bisect good\fR and \fBgit bisect bad\fR to mark commits\&.
260 .SS "Bisect visualize/view"
262 To see the currently remaining suspects in \fIgitk\fR, issue the following command during the bisection process (the subcommand \fBview\fR can be used as an alternative to \fBvisualize\fR):
264 .if n \{\
265 .RS 4
268 $ git bisect visualize
270 .if n \{\
275 If the \fBDISPLAY\fR environment variable is not set, \fIgit log\fR is used instead\&. You can also give command\-line options such as \fB\-p\fR and \fB\-\-stat\fR\&.
277 .if n \{\
278 .RS 4
281 $ git bisect visualize \-\-stat
283 .if n \{\
287 .SS "Bisect log and bisect replay"
289 After having marked revisions as good or bad, issue the following command to show what has been done so far:
291 .if n \{\
292 .RS 4
295 $ git bisect log
297 .if n \{\
302 If you discover that you made a mistake in specifying the status of a revision, you can save the output of this command to a file, edit it to remove the incorrect entries, and then issue the following commands to return to a corrected state:
304 .if n \{\
305 .RS 4
308 $ git bisect reset
309 $ git bisect replay that\-file
311 .if n \{\
315 .SS "Avoiding testing a commit"
317 If, in the middle of a bisect session, you know that the suggested revision is not a good one to test (e\&.g\&. it fails to build and you know that the failure does not have anything to do with the bug you are chasing), you can manually select a nearby commit and test that one instead\&.
319 For example:
321 .if n \{\
322 .RS 4
325 $ git bisect good/bad                   # previous round was good or bad\&.
326 Bisecting: 337 revisions left to test after this (roughly 9 steps)
327 $ git bisect visualize                  # oops, that is uninteresting\&.
328 $ git reset \-\-hard HEAD~3               # try 3 revisions before what
329                                         # was suggested
331 .if n \{\
336 Then compile and test the chosen revision, and afterwards mark the revision as good or bad in the usual manner\&.
337 .SS "Bisect skip"
339 Instead of choosing a nearby commit by yourself, you can ask Git to do it for you by issuing the command:
341 .if n \{\
342 .RS 4
345 $ git bisect skip                 # Current version cannot be tested
347 .if n \{\
352 However, if you skip a commit adjacent to the one you are looking for, Git will be unable to tell exactly which of those commits was the first bad one\&.
354 You can also skip a range of commits, instead of just one commit, using range notation\&. For example:
356 .if n \{\
357 .RS 4
360 $ git bisect skip v2\&.5\&.\&.v2\&.6
362 .if n \{\
367 This tells the bisect process that no commit after \fBv2\&.5\fR, up to and including \fBv2\&.6\fR, should be tested\&.
369 Note that if you also want to skip the first commit of the range you would issue the command:
371 .if n \{\
372 .RS 4
375 $ git bisect skip v2\&.5 v2\&.5\&.\&.v2\&.6
377 .if n \{\
382 This tells the bisect process that the commits between \fBv2\&.5\fR and \fBv2\&.6\fR (inclusive) should be skipped\&.
383 .SS "Cutting down bisection by giving more parameters to bisect start"
385 You can further cut down the number of trials, if you know what part of the tree is involved in the problem you are tracking down, by specifying path parameters when issuing the \fBbisect start\fR command:
387 .if n \{\
388 .RS 4
391 $ git bisect start \-\- arch/i386 include/asm\-i386
393 .if n \{\
398 If you know beforehand more than one good commit, you can narrow the bisect space down by specifying all of the good commits immediately after the bad commit when issuing the \fBbisect start\fR command:
400 .if n \{\
401 .RS 4
404 $ git bisect start v2\&.6\&.20\-rc6 v2\&.6\&.20\-rc4 v2\&.6\&.20\-rc1 \-\-
405                    # v2\&.6\&.20\-rc6 is bad
406                    # v2\&.6\&.20\-rc4 and v2\&.6\&.20\-rc1 are good
408 .if n \{\
412 .SS "Bisect run"
414 If you have a script that can tell if the current source code is good or bad, you can bisect by issuing the command:
416 .if n \{\
417 .RS 4
420 $ git bisect run my_script arguments
422 .if n \{\
427 Note that the script (\fBmy_script\fR in the above example) should exit with code 0 if the current source code is good/old, and exit with a code between 1 and 127 (inclusive), except 125, if the current source code is bad/new\&.
429 Any other exit code will abort the bisect process\&. It should be noted that a program that terminates via \fBexit(\-1)\fR leaves $? = 255, (see the exit(3) manual page), as the value is chopped with \fB& 0377\fR\&.
431 The special exit code 125 should be used when the current source code cannot be tested\&. If the script exits with this code, the current revision will be skipped (see \fBgit bisect skip\fR above)\&. 125 was chosen as the highest sensible value to use for this purpose, because 126 and 127 are used by POSIX shells to signal specific error status (127 is for command not found, 126 is for command found but not executable\(emthese details do not matter, as they are normal errors in the script, as far as \fBbisect run\fR is concerned)\&.
433 You may often find that during a bisect session you want to have temporary modifications (e\&.g\&. s/#define DEBUG 0/#define DEBUG 1/ in a header file, or "revision that does not have this commit needs this patch applied to work around another problem this bisection is not interested in") applied to the revision being tested\&.
435 To cope with such a situation, after the inner \fIgit bisect\fR finds the next revision to test, the script can apply the patch before compiling, run the real test, and afterwards decide if the revision (possibly with the needed patch) passed the test and then rewind the tree to the pristine state\&. Finally the script should exit with the status of the real test to let the \fBgit bisect run\fR command loop determine the eventual outcome of the bisect session\&.
436 .SH "OPTIONS"
438 \-\-no\-checkout
439 .RS 4
440 Do not checkout the new working tree at each iteration of the bisection process\&. Instead just update a special reference named
441 \fBBISECT_HEAD\fR
442 to make it point to the commit that should be tested\&.
444 This option may be useful when the test you would perform in each step does not require a checked out tree\&.
446 If the repository is bare,
447 \fB\-\-no\-checkout\fR
448 is assumed\&.
451 \-\-first\-parent
452 .RS 4
453 Follow only the first parent commit upon seeing a merge commit\&.
455 In detecting regressions introduced through the merging of a branch, the merge commit will be identified as introduction of the bug and its ancestors will be ignored\&.
457 This option is particularly useful in avoiding false positives when a merged branch contained broken or non\-buildable commits, but the merge itself was OK\&.
459 .SH "EXAMPLES"
461 .RS 4
462 .ie n \{\
463 \h'-04'\(bu\h'+03'\c
465 .el \{\
466 .sp -1
467 .IP \(bu 2.3
469 Automatically bisect a broken build between v1\&.2 and HEAD:
471 .if n \{\
472 .RS 4
475 $ git bisect start HEAD v1\&.2 \-\-      # HEAD is bad, v1\&.2 is good
476 $ git bisect run make                # "make" builds the app
477 $ git bisect reset                   # quit the bisect session
479 .if n \{\
485 .RS 4
486 .ie n \{\
487 \h'-04'\(bu\h'+03'\c
489 .el \{\
490 .sp -1
491 .IP \(bu 2.3
493 Automatically bisect a test failure between origin and HEAD:
495 .if n \{\
496 .RS 4
499 $ git bisect start HEAD origin \-\-    # HEAD is bad, origin is good
500 $ git bisect run make test           # "make test" builds and tests
501 $ git bisect reset                   # quit the bisect session
503 .if n \{\
509 .RS 4
510 .ie n \{\
511 \h'-04'\(bu\h'+03'\c
513 .el \{\
514 .sp -1
515 .IP \(bu 2.3
517 Automatically bisect a broken test case:
519 .if n \{\
520 .RS 4
523 $ cat ~/test\&.sh
524 #!/bin/sh
525 make || exit 125                     # this skips broken builds
526 ~/check_test_case\&.sh                 # does the test case pass?
527 $ git bisect start HEAD HEAD~10 \-\-   # culprit is among the last 10
528 $ git bisect run ~/test\&.sh
529 $ git bisect reset                   # quit the bisect session
531 .if n \{\
535 Here we use a
536 \fBtest\&.sh\fR
537 custom script\&. In this script, if
538 \fBmake\fR
539 fails, we skip the current commit\&.
540 \fBcheck_test_case\&.sh\fR
541 should
542 \fBexit 0\fR
543 if the test case passes, and
544 \fBexit 1\fR
545 otherwise\&.
547 It is safer if both
548 \fBtest\&.sh\fR
550 \fBcheck_test_case\&.sh\fR
551 are outside the repository to prevent interactions between the bisect, make and test processes and the scripts\&.
554 .RS 4
555 .ie n \{\
556 \h'-04'\(bu\h'+03'\c
558 .el \{\
559 .sp -1
560 .IP \(bu 2.3
562 Automatically bisect with temporary modifications (hot\-fix):
564 .if n \{\
565 .RS 4
568 $ cat ~/test\&.sh
569 #!/bin/sh
571 # tweak the working tree by merging the hot\-fix branch
572 # and then attempt a build
573 if      git merge \-\-no\-commit \-\-no\-ff hot\-fix &&
574         make
575 then
576         # run project specific test and report its status
577         ~/check_test_case\&.sh
578         status=$?
579 else
580         # tell the caller this is untestable
581         status=125
584 # undo the tweak to allow clean flipping to the next commit
585 git reset \-\-hard
587 # return control
588 exit $status
590 .if n \{\
594 This applies modifications from a hot\-fix branch before each test run, e\&.g\&. in case your build or test environment changed so that older revisions may need a fix which newer ones have already\&. (Make sure the hot\-fix branch is based off a commit which is contained in all revisions which you are bisecting, so that the merge does not pull in too much, or use
595 \fBgit cherry\-pick\fR
596 instead of
597 \fBgit merge\fR\&.)
600 .RS 4
601 .ie n \{\
602 \h'-04'\(bu\h'+03'\c
604 .el \{\
605 .sp -1
606 .IP \(bu 2.3
608 Automatically bisect a broken test case:
610 .if n \{\
611 .RS 4
614 $ git bisect start HEAD HEAD~10 \-\-   # culprit is among the last 10
615 $ git bisect run sh \-c "make || exit 125; ~/check_test_case\&.sh"
616 $ git bisect reset                   # quit the bisect session
618 .if n \{\
622 This shows that you can do without a run script if you write the test on a single line\&.
625 .RS 4
626 .ie n \{\
627 \h'-04'\(bu\h'+03'\c
629 .el \{\
630 .sp -1
631 .IP \(bu 2.3
633 Locate a good region of the object graph in a damaged repository
635 .if n \{\
636 .RS 4
639 $ git bisect start HEAD <known\-good\-commit> [ <boundary\-commit> \&.\&.\&. ] \-\-no\-checkout
640 $ git bisect run sh \-c \(aq
641         GOOD=$(git for\-each\-ref "\-\-format=%(objectname)" refs/bisect/good\-*) &&
642         git rev\-list \-\-objects BISECT_HEAD \-\-not $GOOD >tmp\&.$$ &&
643         git pack\-objects \-\-stdout >/dev/null <tmp\&.$$
644         rc=$?
645         rm \-f tmp\&.$$
646         test $rc = 0\(aq
648 $ git bisect reset                   # quit the bisect session
650 .if n \{\
654 In this case, when
655 \fIgit bisect run\fR
656 finishes, bisect/bad will refer to a commit that has at least one parent whose reachable graph is fully traversable in the sense required by
657 \fIgit pack objects\fR\&.
660 .RS 4
661 .ie n \{\
662 \h'-04'\(bu\h'+03'\c
664 .el \{\
665 .sp -1
666 .IP \(bu 2.3
668 Look for a fix instead of a regression in the code
670 .if n \{\
671 .RS 4
674 $ git bisect start
675 $ git bisect new HEAD    # current commit is marked as new
676 $ git bisect old HEAD~10 # the tenth commit from now is marked as old
678 .if n \{\
685 .if n \{\
686 .RS 4
689 $ git bisect start \-\-term\-old broken \-\-term\-new fixed
690 $ git bisect fixed
691 $ git bisect broken HEAD~10
693 .if n \{\
697 .SS "Getting help"
699 Use \fBgit bisect\fR to get a short usage description, and \fBgit bisect help\fR or \fBgit bisect \-h\fR to get a long usage description\&.
700 .SH "SEE ALSO"
702 \m[blue]\fBFighting regressions with git bisect\fR\m[]\&\s-2\u[1]\d\s+2, \fBgit-blame\fR(1)\&.
703 .SH "GIT"
705 Part of the \fBgit\fR(1) suite
706 .SH "NOTES"
707 .IP " 1." 4
708 Fighting regressions with git bisect
709 .RS 4
710 \%git-htmldocs/git-bisect-lk2009.html