Autogenerated HTML docs for v2.45.0-31-gd4cc1
[git-htmldocs.git] / git-bisect.txt
blob82f944dc03dffccae2425cb3a250d681ad3ed134
1 git-bisect(1)
2 =============
4 NAME
5 ----
6 git-bisect - Use binary search to find the commit that introduced a bug
9 SYNOPSIS
10 --------
11 [verse]
12 'git bisect' <subcommand> <options>
14 DESCRIPTION
15 -----------
16 The command takes various subcommands, and different options depending
17 on the subcommand:
19  git bisect start [--term-(bad|new)=<term-new> --term-(good|old)=<term-old>]
20                   [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<pathspec>...]
21  git bisect (bad|new|<term-new>) [<rev>]
22  git bisect (good|old|<term-old>) [<rev>...]
23  git bisect terms [--term-(good|old) | --term-(bad|new)]
24  git bisect skip [(<rev>|<range>)...]
25  git bisect reset [<commit>]
26  git bisect (visualize|view)
27  git bisect replay <logfile>
28  git bisect log
29  git bisect run <cmd> [<arg>...]
30  git bisect help
32 This command uses a binary search algorithm to find which commit in
33 your project's history introduced a bug. You use it by first telling
34 it a "bad" commit that is known to contain the bug, and a "good"
35 commit that is known to be before the bug was introduced. Then `git
36 bisect` picks a commit between those two endpoints and asks you
37 whether the selected commit is "good" or "bad". It continues narrowing
38 down the range until it finds the exact commit that introduced the
39 change.
41 In fact, `git bisect` can be used to find the commit that changed
42 *any* property of your project; e.g., the commit that fixed a bug, or
43 the commit that caused a benchmark's performance to improve. To
44 support this more general usage, the terms "old" and "new" can be used
45 in place of "good" and "bad", or you can choose your own terms. See
46 section "Alternate terms" below for more information.
48 Basic bisect commands: start, bad, good
49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51 As an example, suppose you are trying to find the commit that broke a
52 feature that was known to work in version `v2.6.13-rc2` of your
53 project. You start a bisect session as follows:
55 ------------------------------------------------
56 $ git bisect start
57 $ git bisect bad                 # Current version is bad
58 $ git bisect good v2.6.13-rc2    # v2.6.13-rc2 is known to be good
59 ------------------------------------------------
61 Once you have specified at least one bad and one good commit, `git
62 bisect` selects a commit in the middle of that range of history,
63 checks it out, and outputs something similar to the following:
65 ------------------------------------------------
66 Bisecting: 675 revisions left to test after this (roughly 10 steps)
67 ------------------------------------------------
69 You should now compile the checked-out version and test it. If that
70 version works correctly, type
72 ------------------------------------------------
73 $ git bisect good
74 ------------------------------------------------
76 If that version is broken, type
78 ------------------------------------------------
79 $ git bisect bad
80 ------------------------------------------------
82 Then `git bisect` will respond with something like
84 ------------------------------------------------
85 Bisecting: 337 revisions left to test after this (roughly 9 steps)
86 ------------------------------------------------
88 Keep repeating the process: compile the tree, test it, and depending
89 on whether it is good or bad run `git bisect good` or `git bisect bad`
90 to ask for the next commit that needs testing.
92 Eventually there will be no more revisions left to inspect, and the
93 command will print out a description of the first bad commit. The
94 reference `refs/bisect/bad` will be left pointing at that commit.
97 Bisect reset
98 ~~~~~~~~~~~~
100 After a bisect session, to clean up the bisection state and return to
101 the original HEAD, issue the following command:
103 ------------------------------------------------
104 $ git bisect reset
105 ------------------------------------------------
107 By default, this will return your tree to the commit that was checked
108 out before `git bisect start`.  (A new `git bisect start` will also do
109 that, as it cleans up the old bisection state.)
111 With an optional argument, you can return to a different commit
112 instead:
114 ------------------------------------------------
115 $ git bisect reset <commit>
116 ------------------------------------------------
118 For example, `git bisect reset bisect/bad` will check out the first
119 bad revision, while `git bisect reset HEAD` will leave you on the
120 current bisection commit and avoid switching commits at all.
123 Alternate terms
124 ~~~~~~~~~~~~~~~
126 Sometimes you are not looking for the commit that introduced a
127 breakage, but rather for a commit that caused a change between some
128 other "old" state and "new" state. For example, you might be looking
129 for the commit that introduced a particular fix. Or you might be
130 looking for the first commit in which the source-code filenames were
131 finally all converted to your company's naming standard. Or whatever.
133 In such cases it can be very confusing to use the terms "good" and
134 "bad" to refer to "the state before the change" and "the state after
135 the change". So instead, you can use the terms "old" and "new",
136 respectively, in place of "good" and "bad". (But note that you cannot
137 mix "good" and "bad" with "old" and "new" in a single session.)
139 In this more general usage, you provide `git bisect` with a "new"
140 commit that has some property and an "old" commit that doesn't have that
141 property. Each time `git bisect` checks out a commit, you test if that
142 commit has the property. If it does, mark the commit as "new";
143 otherwise, mark it as "old". When the bisection is done, `git bisect`
144 will report which commit introduced the property.
146 To use "old" and "new" instead of "good" and bad, you must run `git
147 bisect start` without commits as argument and then run the following
148 commands to add the commits:
150 ------------------------------------------------
151 git bisect old [<rev>]
152 ------------------------------------------------
154 to indicate that a commit was before the sought change, or
156 ------------------------------------------------
157 git bisect new [<rev>...]
158 ------------------------------------------------
160 to indicate that it was after.
162 To get a reminder of the currently used terms, use
164 ------------------------------------------------
165 git bisect terms
166 ------------------------------------------------
168 You can get just the old term with `git bisect terms --term-old`
169 or `git bisect terms --term-good`; `git bisect terms --term-new`
170 and `git bisect terms --term-bad` can be used to learn how to call
171 the commits more recent than the sought change.
173 If you would like to use your own terms instead of "bad"/"good" or
174 "new"/"old", you can choose any names you like (except existing bisect
175 subcommands like `reset`, `start`, ...) by starting the
176 bisection using
178 ------------------------------------------------
179 git bisect start --term-old <term-old> --term-new <term-new>
180 ------------------------------------------------
182 For example, if you are looking for a commit that introduced a
183 performance regression, you might use
185 ------------------------------------------------
186 git bisect start --term-old fast --term-new slow
187 ------------------------------------------------
189 Or if you are looking for the commit that fixed a bug, you might use
191 ------------------------------------------------
192 git bisect start --term-new fixed --term-old broken
193 ------------------------------------------------
195 Then, use `git bisect <term-old>` and `git bisect <term-new>` instead
196 of `git bisect good` and `git bisect bad` to mark commits.
198 Bisect visualize/view
199 ~~~~~~~~~~~~~~~~~~~~~
201 To see the currently remaining suspects in 'gitk', issue the following
202 command during the bisection process (the subcommand `view` can be used
203 as an alternative to `visualize`):
205 ------------
206 $ git bisect visualize
207 ------------
209 Git detects a graphical environment through various environment variables:
210 `DISPLAY`, which is set in X Window System environments on Unix systems.
211 `SESSIONNAME`, which is set under Cygwin in interactive desktop sessions.
212 `MSYSTEM`, which is set under Msys2 and Git for Windows.
213 `SECURITYSESSIONID`, which may be set on macOS in interactive desktop sessions.
215 If none of these environment variables is set, 'git log' is used instead.
216 You can also give command-line options such as `-p` and `--stat`.
218 ------------
219 $ git bisect visualize --stat
220 ------------
222 Bisect log and bisect replay
223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
225 After having marked revisions as good or bad, issue the following
226 command to show what has been done so far:
228 ------------
229 $ git bisect log
230 ------------
232 If you discover that you made a mistake in specifying the status of a
233 revision, you can save the output of this command to a file, edit it to
234 remove the incorrect entries, and then issue the following commands to
235 return to a corrected state:
237 ------------
238 $ git bisect reset
239 $ git bisect replay that-file
240 ------------
242 Avoiding testing a commit
243 ~~~~~~~~~~~~~~~~~~~~~~~~~
245 If, in the middle of a bisect session, you know that the suggested
246 revision is not a good one to test (e.g. it fails to build and you
247 know that the failure does not have anything to do with the bug you
248 are chasing), you can manually select a nearby commit and test that
249 one instead.
251 For example:
253 ------------
254 $ git bisect good/bad                   # previous round was good or bad.
255 Bisecting: 337 revisions left to test after this (roughly 9 steps)
256 $ git bisect visualize                  # oops, that is uninteresting.
257 $ git reset --hard HEAD~3               # try 3 revisions before what
258                                         # was suggested
259 ------------
261 Then compile and test the chosen revision, and afterwards mark
262 the revision as good or bad in the usual manner.
264 Bisect skip
265 ~~~~~~~~~~~
267 Instead of choosing a nearby commit by yourself, you can ask Git to do
268 it for you by issuing the command:
270 ------------
271 $ git bisect skip                 # Current version cannot be tested
272 ------------
274 However, if you skip a commit adjacent to the one you are looking for,
275 Git will be unable to tell exactly which of those commits was the
276 first bad one.
278 You can also skip a range of commits, instead of just one commit,
279 using range notation. For example:
281 ------------
282 $ git bisect skip v2.5..v2.6
283 ------------
285 This tells the bisect process that no commit after `v2.5`, up to and
286 including `v2.6`, should be tested.
288 Note that if you also want to skip the first commit of the range you
289 would issue the command:
291 ------------
292 $ git bisect skip v2.5 v2.5..v2.6
293 ------------
295 This tells the bisect process that the commits between `v2.5` and
296 `v2.6` (inclusive) should be skipped.
299 Cutting down bisection by giving more parameters to bisect start
300 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
302 You can further cut down the number of trials, if you know what part of
303 the tree is involved in the problem you are tracking down, by specifying
304 pathspec parameters when issuing the `bisect start` command:
306 ------------
307 $ git bisect start -- arch/i386 include/asm-i386
308 ------------
310 If you know beforehand more than one good commit, you can narrow the
311 bisect space down by specifying all of the good commits immediately after
312 the bad commit when issuing the `bisect start` command:
314 ------------
315 $ git bisect start v2.6.20-rc6 v2.6.20-rc4 v2.6.20-rc1 --
316                    # v2.6.20-rc6 is bad
317                    # v2.6.20-rc4 and v2.6.20-rc1 are good
318 ------------
320 Bisect run
321 ~~~~~~~~~~
323 If you have a script that can tell if the current source code is good
324 or bad, you can bisect by issuing the command:
326 ------------
327 $ git bisect run my_script arguments
328 ------------
330 Note that the script (`my_script` in the above example) should exit
331 with code 0 if the current source code is good/old, and exit with a
332 code between 1 and 127 (inclusive), except 125, if the current source
333 code is bad/new.
335 Any other exit code will abort the bisect process. It should be noted
336 that a program that terminates via `exit(-1)` leaves $? = 255, (see the
337 exit(3) manual page), as the value is chopped with `& 0377`.
339 The special exit code 125 should be used when the current source code
340 cannot be tested. If the script exits with this code, the current
341 revision will be skipped (see `git bisect skip` above). 125 was chosen
342 as the highest sensible value to use for this purpose, because 126 and 127
343 are used by POSIX shells to signal specific error status (127 is for
344 command not found, 126 is for command found but not executable--these
345 details do not matter, as they are normal errors in the script, as far as
346 `bisect run` is concerned).
348 You may often find that during a bisect session you want to have
349 temporary modifications (e.g. s/#define DEBUG 0/#define DEBUG 1/ in a
350 header file, or "revision that does not have this commit needs this
351 patch applied to work around another problem this bisection is not
352 interested in") applied to the revision being tested.
354 To cope with such a situation, after the inner 'git bisect' finds the
355 next revision to test, the script can apply the patch
356 before compiling, run the real test, and afterwards decide if the
357 revision (possibly with the needed patch) passed the test and then
358 rewind the tree to the pristine state.  Finally the script should exit
359 with the status of the real test to let the `git bisect run` command loop
360 determine the eventual outcome of the bisect session.
362 OPTIONS
363 -------
364 --no-checkout::
366 Do not checkout the new working tree at each iteration of the bisection
367 process. Instead just update the reference named `BISECT_HEAD` to make
368 it point to the commit that should be tested.
370 This option may be useful when the test you would perform in each step
371 does not require a checked out tree.
373 If the repository is bare, `--no-checkout` is assumed.
375 --first-parent::
377 Follow only the first parent commit upon seeing a merge commit.
379 In detecting regressions introduced through the merging of a branch, the merge
380 commit will be identified as introduction of the bug and its ancestors will be
381 ignored.
383 This option is particularly useful in avoiding false positives when a merged
384 branch contained broken or non-buildable commits, but the merge itself was OK.
386 EXAMPLES
387 --------
389 * Automatically bisect a broken build between v1.2 and HEAD:
391 ------------
392 $ git bisect start HEAD v1.2 --      # HEAD is bad, v1.2 is good
393 $ git bisect run make                # "make" builds the app
394 $ git bisect reset                   # quit the bisect session
395 ------------
397 * Automatically bisect a test failure between origin and HEAD:
399 ------------
400 $ git bisect start HEAD origin --    # HEAD is bad, origin is good
401 $ git bisect run make test           # "make test" builds and tests
402 $ git bisect reset                   # quit the bisect session
403 ------------
405 * Automatically bisect a broken test case:
407 ------------
408 $ cat ~/test.sh
409 #!/bin/sh
410 make || exit 125                     # this skips broken builds
411 ~/check_test_case.sh                 # does the test case pass?
412 $ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
413 $ git bisect run ~/test.sh
414 $ git bisect reset                   # quit the bisect session
415 ------------
417 Here we use a `test.sh` custom script. In this script, if `make`
418 fails, we skip the current commit.
419 `check_test_case.sh` should `exit 0` if the test case passes,
420 and `exit 1` otherwise.
422 It is safer if both `test.sh` and `check_test_case.sh` are
423 outside the repository to prevent interactions between the bisect,
424 make and test processes and the scripts.
426 * Automatically bisect with temporary modifications (hot-fix):
428 ------------
429 $ cat ~/test.sh
430 #!/bin/sh
432 # tweak the working tree by merging the hot-fix branch
433 # and then attempt a build
434 if      git merge --no-commit --no-ff hot-fix &&
435         make
436 then
437         # run project specific test and report its status
438         ~/check_test_case.sh
439         status=$?
440 else
441         # tell the caller this is untestable
442         status=125
445 # undo the tweak to allow clean flipping to the next commit
446 git reset --hard
448 # return control
449 exit $status
450 ------------
452 This applies modifications from a hot-fix branch before each test run,
453 e.g. in case your build or test environment changed so that older
454 revisions may need a fix which newer ones have already. (Make sure the
455 hot-fix branch is based off a commit which is contained in all revisions
456 which you are bisecting, so that the merge does not pull in too much, or
457 use `git cherry-pick` instead of `git merge`.)
459 * Automatically bisect a broken test case:
461 ------------
462 $ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
463 $ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"
464 $ git bisect reset                   # quit the bisect session
465 ------------
467 This shows that you can do without a run script if you write the test
468 on a single line.
470 * Locate a good region of the object graph in a damaged repository
472 ------------
473 $ git bisect start HEAD <known-good-commit> [ <boundary-commit> ... ] --no-checkout
474 $ git bisect run sh -c '
475         GOOD=$(git for-each-ref "--format=%(objectname)" refs/bisect/good-*) &&
476         git rev-list --objects BISECT_HEAD --not $GOOD >tmp.$$ &&
477         git pack-objects --stdout >/dev/null <tmp.$$
478         rc=$?
479         rm -f tmp.$$
480         test $rc = 0'
482 $ git bisect reset                   # quit the bisect session
483 ------------
485 In this case, when 'git bisect run' finishes, bisect/bad will refer to a commit that
486 has at least one parent whose reachable graph is fully traversable in the sense
487 required by 'git pack objects'.
489 * Look for a fix instead of a regression in the code
491 ------------
492 $ git bisect start
493 $ git bisect new HEAD    # current commit is marked as new
494 $ git bisect old HEAD~10 # the tenth commit from now is marked as old
495 ------------
498 ------------
499 $ git bisect start --term-old broken --term-new fixed
500 $ git bisect fixed
501 $ git bisect broken HEAD~10
502 ------------
504 Getting help
505 ~~~~~~~~~~~~
507 Use `git bisect` to get a short usage description, and `git bisect
508 help` or `git bisect -h` to get a long usage description.
510 SEE ALSO
511 --------
512 link:git-bisect-lk2009.html[Fighting regressions with git bisect],
513 linkgit:git-blame[1].
517 Part of the linkgit:git[1] suite