bisect: add 'git bisect terms' to view the current terms
[git.git] / Documentation / git-bisect.txt
blob4dd62958098f4b3ce3a9759b41e96b187f732a4f
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 [--no-checkout] [<bad> [<good>...]] [--] [<paths>...]
20  git bisect (bad|new) [<rev>]
21  git bisect (good|old) [<rev>...]
22  git bisect terms [--term-good | --term-bad]
23  git bisect skip [(<rev>|<range>)...]
24  git bisect reset [<commit>]
25  git bisect visualize
26  git bisect replay <logfile>
27  git bisect log
28  git bisect run <cmd>...
29  git bisect help
31 This command uses a binary search algorithm to find which commit in
32 your project's history introduced a bug. You use it by first telling
33 it a "bad" commit that is known to contain the bug, and a "good"
34 commit that is known to be before the bug was introduced. Then `git
35 bisect` picks a commit between those two endpoints and asks you
36 whether the selected commit is "good" or "bad". It continues narrowing
37 down the range until it finds the exact commit that introduced the
38 change.
40 In fact, `git bisect` can be used to find the commit that changed
41 *any* property of your project; e.g., the commit that fixed a bug, or
42 the commit that caused a benchmark's performance to improve. To
43 support this more general usage, the terms "old" and "new" can be used
44 in place of "good" and "bad". See
45 section "Alternate terms" below for more information.
47 Basic bisect commands: start, bad, good
48 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50 As an example, suppose you are trying to find the commit that broke a
51 feature that was known to work in version `v2.6.13-rc2` of your
52 project. You start a bisect session as follows:
54 ------------------------------------------------
55 $ git bisect start
56 $ git bisect bad                 # Current version is bad
57 $ git bisect good v2.6.13-rc2    # v2.6.13-rc2 is known to be good
58 ------------------------------------------------
60 Once you have specified at least one bad and one good commit, `git
61 bisect` selects a commit in the middle of that range of history,
62 checks it out, and outputs something similar to the following:
64 ------------------------------------------------
65 Bisecting: 675 revisions left to test after this (roughly 10 steps)
66 ------------------------------------------------
68 You should now compile the checked-out version and test it. If that
69 version works correctly, type
71 ------------------------------------------------
72 $ git bisect good
73 ------------------------------------------------
75 If that version is broken, type
77 ------------------------------------------------
78 $ git bisect bad
79 ------------------------------------------------
81 Then `git bisect` will respond with something like
83 ------------------------------------------------
84 Bisecting: 337 revisions left to test after this (roughly 9 steps)
85 ------------------------------------------------
87 Keep repeating the process: compile the tree, test it, and depending
88 on whether it is good or bad run `git bisect good` or `git bisect bad`
89 to ask for the next commit that needs testing.
91 Eventually there will be no more revisions left to inspect, and the
92 command will print out a description of the first bad commit. The
93 reference `refs/bisect/bad` will be left pointing at that commit.
96 Bisect reset
97 ~~~~~~~~~~~~
99 After a bisect session, to clean up the bisection state and return to
100 the original HEAD, issue the following command:
102 ------------------------------------------------
103 $ git bisect reset
104 ------------------------------------------------
106 By default, this will return your tree to the commit that was checked
107 out before `git bisect start`.  (A new `git bisect start` will also do
108 that, as it cleans up the old bisection state.)
110 With an optional argument, you can return to a different commit
111 instead:
113 ------------------------------------------------
114 $ git bisect reset <commit>
115 ------------------------------------------------
117 For example, `git bisect reset bisect/bad` will check out the first
118 bad revision, while `git bisect reset HEAD` will leave you on the
119 current bisection commit and avoid switching commits at all.
122 Alternate terms
123 ~~~~~~~~~~~~~~~
125 Sometimes you are not looking for the commit that introduced a
126 breakage, but rather for a commit that caused a change between some
127 other "old" state and "new" state. For example, you might be looking
128 for the commit that introduced a particular fix. Or you might be
129 looking for the first commit in which the source-code filenames were
130 finally all converted to your company's naming standard. Or whatever.
132 In such cases it can be very confusing to use the terms "good" and
133 "bad" to refer to "the state before the change" and "the state after
134 the change". So instead, you can use the terms "old" and "new",
135 respectively, in place of "good" and "bad". (But note that you cannot
136 mix "good" and "bad" with "old" and "new" in a single session.)
138 In this more general usage, you provide `git bisect` with a "new"
139 commit has some property and an "old" commit that doesn't have that
140 property. Each time `git bisect` checks out a commit, you test if that
141 commit has the property. If it does, mark the commit as "new";
142 otherwise, mark it as "old". When the bisection is done, `git bisect`
143 will report which commit introduced the property.
145 To use "old" and "new" instead of "good" and bad, you must run `git
146 bisect start` without commits as argument and then run the following
147 commands to add the commits:
149 ------------------------------------------------
150 git bisect old [<rev>]
151 ------------------------------------------------
153 to indicate that a commit was before the sought change, or
155 ------------------------------------------------
156 git bisect new [<rev>...]
157 ------------------------------------------------
159 to indicate that it was after.
161 To get a reminder of the currently used terms, use
163 ------------------------------------------------
164 git bisect terms
165 ------------------------------------------------
167 You can get just the old (respectively new) term with `git bisect term
168 --term-old` or `git bisect term --term-good`.
170 Bisect visualize
171 ~~~~~~~~~~~~~~~~
173 To see the currently remaining suspects in 'gitk', issue the following
174 command during the bisection process:
176 ------------
177 $ git bisect visualize
178 ------------
180 `view` may also be used as a synonym for `visualize`.
182 If the 'DISPLAY' environment variable is not set, 'git log' is used
183 instead.  You can also give command-line options such as `-p` and
184 `--stat`.
186 ------------
187 $ git bisect view --stat
188 ------------
190 Bisect log and bisect replay
191 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193 After having marked revisions as good or bad, issue the following
194 command to show what has been done so far:
196 ------------
197 $ git bisect log
198 ------------
200 If you discover that you made a mistake in specifying the status of a
201 revision, you can save the output of this command to a file, edit it to
202 remove the incorrect entries, and then issue the following commands to
203 return to a corrected state:
205 ------------
206 $ git bisect reset
207 $ git bisect replay that-file
208 ------------
210 Avoiding testing a commit
211 ~~~~~~~~~~~~~~~~~~~~~~~~~
213 If, in the middle of a bisect session, you know that the suggested
214 revision is not a good one to test (e.g. it fails to build and you
215 know that the failure does not have anything to do with the bug you
216 are chasing), you can manually select a nearby commit and test that
217 one instead.
219 For example:
221 ------------
222 $ git bisect good/bad                   # previous round was good or bad.
223 Bisecting: 337 revisions left to test after this (roughly 9 steps)
224 $ git bisect visualize                  # oops, that is uninteresting.
225 $ git reset --hard HEAD~3               # try 3 revisions before what
226                                         # was suggested
227 ------------
229 Then compile and test the chosen revision, and afterwards mark
230 the revision as good or bad in the usual manner.
232 Bisect skip
233 ~~~~~~~~~~~~
235 Instead of choosing a nearby commit by yourself, you can ask Git to do
236 it for you by issuing the command:
238 ------------
239 $ git bisect skip                 # Current version cannot be tested
240 ------------
242 However, if you skip a commit adjacent to the one you are looking for,
243 Git will be unable to tell exactly which of those commits was the
244 first bad one.
246 You can also skip a range of commits, instead of just one commit,
247 using range notation. For example:
249 ------------
250 $ git bisect skip v2.5..v2.6
251 ------------
253 This tells the bisect process that no commit after `v2.5`, up to and
254 including `v2.6`, should be tested.
256 Note that if you also want to skip the first commit of the range you
257 would issue the command:
259 ------------
260 $ git bisect skip v2.5 v2.5..v2.6
261 ------------
263 This tells the bisect process that the commits between `v2.5` and
264 `v2.6` (inclusive) should be skipped.
267 Cutting down bisection by giving more parameters to bisect start
268 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
270 You can further cut down the number of trials, if you know what part of
271 the tree is involved in the problem you are tracking down, by specifying
272 path parameters when issuing the `bisect start` command:
274 ------------
275 $ git bisect start -- arch/i386 include/asm-i386
276 ------------
278 If you know beforehand more than one good commit, you can narrow the
279 bisect space down by specifying all of the good commits immediately after
280 the bad commit when issuing the `bisect start` command:
282 ------------
283 $ git bisect start v2.6.20-rc6 v2.6.20-rc4 v2.6.20-rc1 --
284                    # v2.6.20-rc6 is bad
285                    # v2.6.20-rc4 and v2.6.20-rc1 are good
286 ------------
288 Bisect run
289 ~~~~~~~~~~
291 If you have a script that can tell if the current source code is good
292 or bad, you can bisect by issuing the command:
294 ------------
295 $ git bisect run my_script arguments
296 ------------
298 Note that the script (`my_script` in the above example) should exit
299 with code 0 if the current source code is good/old, and exit with a
300 code between 1 and 127 (inclusive), except 125, if the current source
301 code is bad/new.
303 Any other exit code will abort the bisect process. It should be noted
304 that a program that terminates via `exit(-1)` leaves $? = 255, (see the
305 exit(3) manual page), as the value is chopped with `& 0377`.
307 The special exit code 125 should be used when the current source code
308 cannot be tested. If the script exits with this code, the current
309 revision will be skipped (see `git bisect skip` above). 125 was chosen
310 as the highest sensible value to use for this purpose, because 126 and 127
311 are used by POSIX shells to signal specific error status (127 is for
312 command not found, 126 is for command found but not executable---these
313 details do not matter, as they are normal errors in the script, as far as
314 `bisect run` is concerned).
316 You may often find that during a bisect session you want to have
317 temporary modifications (e.g. s/#define DEBUG 0/#define DEBUG 1/ in a
318 header file, or "revision that does not have this commit needs this
319 patch applied to work around another problem this bisection is not
320 interested in") applied to the revision being tested.
322 To cope with such a situation, after the inner 'git bisect' finds the
323 next revision to test, the script can apply the patch
324 before compiling, run the real test, and afterwards decide if the
325 revision (possibly with the needed patch) passed the test and then
326 rewind the tree to the pristine state.  Finally the script should exit
327 with the status of the real test to let the `git bisect run` command loop
328 determine the eventual outcome of the bisect session.
330 OPTIONS
331 -------
332 --no-checkout::
334 Do not checkout the new working tree at each iteration of the bisection
335 process. Instead just update a special reference named 'BISECT_HEAD' to make
336 it point to the commit that should be tested.
338 This option may be useful when the test you would perform in each step
339 does not require a checked out tree.
341 If the repository is bare, `--no-checkout` is assumed.
343 EXAMPLES
344 --------
346 * Automatically bisect a broken build between v1.2 and HEAD:
348 ------------
349 $ git bisect start HEAD v1.2 --      # HEAD is bad, v1.2 is good
350 $ git bisect run make                # "make" builds the app
351 $ git bisect reset                   # quit the bisect session
352 ------------
354 * Automatically bisect a test failure between origin and HEAD:
356 ------------
357 $ git bisect start HEAD origin --    # HEAD is bad, origin is good
358 $ git bisect run make test           # "make test" builds and tests
359 $ git bisect reset                   # quit the bisect session
360 ------------
362 * Automatically bisect a broken test case:
364 ------------
365 $ cat ~/test.sh
366 #!/bin/sh
367 make || exit 125                     # this skips broken builds
368 ~/check_test_case.sh                 # does the test case pass?
369 $ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
370 $ git bisect run ~/test.sh
371 $ git bisect reset                   # quit the bisect session
372 ------------
374 Here we use a `test.sh` custom script. In this script, if `make`
375 fails, we skip the current commit.
376 `check_test_case.sh` should `exit 0` if the test case passes,
377 and `exit 1` otherwise.
379 It is safer if both `test.sh` and `check_test_case.sh` are
380 outside the repository to prevent interactions between the bisect,
381 make and test processes and the scripts.
383 * Automatically bisect with temporary modifications (hot-fix):
385 ------------
386 $ cat ~/test.sh
387 #!/bin/sh
389 # tweak the working tree by merging the hot-fix branch
390 # and then attempt a build
391 if      git merge --no-commit hot-fix &&
392         make
393 then
394         # run project specific test and report its status
395         ~/check_test_case.sh
396         status=$?
397 else
398         # tell the caller this is untestable
399         status=125
402 # undo the tweak to allow clean flipping to the next commit
403 git reset --hard
405 # return control
406 exit $status
407 ------------
409 This applies modifications from a hot-fix branch before each test run,
410 e.g. in case your build or test environment changed so that older
411 revisions may need a fix which newer ones have already. (Make sure the
412 hot-fix branch is based off a commit which is contained in all revisions
413 which you are bisecting, so that the merge does not pull in too much, or
414 use `git cherry-pick` instead of `git merge`.)
416 * Automatically bisect a broken test case:
418 ------------
419 $ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
420 $ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"
421 $ git bisect reset                   # quit the bisect session
422 ------------
424 This shows that you can do without a run script if you write the test
425 on a single line.
427 * Locate a good region of the object graph in a damaged repository
429 ------------
430 $ git bisect start HEAD <known-good-commit> [ <boundary-commit> ... ] --no-checkout
431 $ git bisect run sh -c '
432         GOOD=$(git for-each-ref "--format=%(objectname)" refs/bisect/good-*) &&
433         git rev-list --objects BISECT_HEAD --not $GOOD >tmp.$$ &&
434         git pack-objects --stdout >/dev/null <tmp.$$
435         rc=$?
436         rm -f tmp.$$
437         test $rc = 0'
439 $ git bisect reset                   # quit the bisect session
440 ------------
442 In this case, when 'git bisect run' finishes, bisect/bad will refer to a commit that
443 has at least one parent whose reachable graph is fully traversable in the sense
444 required by 'git pack objects'.
446 * Look for a fix instead of a regression in the code
448 ------------
449 $ git bisect start
450 $ git bisect new HEAD    # current commit is marked as new
451 $ git bisect old HEAD~10 # the tenth commit from now is marked as old
452 ------------
454 Getting help
455 ~~~~~~~~~~~~
457 Use `git bisect` to get a short usage description, and `git bisect
458 help` or `git bisect -h` to get a long usage description.
460 SEE ALSO
461 --------
462 link:git-bisect-lk2009.html[Fighting regressions with git bisect],
463 linkgit:git-blame[1].
467 Part of the linkgit:git[1] suite