Documentation/git-bisect.txt

   1 git-bisect(1)
   2 =============
   3
   4 NAME
   5 ----
   6 git-bisect - Find by binary search the change that introduced a bug
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git bisect' <subcommand> <options>
  12
  13 DESCRIPTION
  14 -----------
  15 The command takes various subcommands, and different options depending
  16 on the subcommand:
  17
  18  git bisect help
  19  git bisect start [<bad> [<good>...]] [--] [<paths>...]
  20  git bisect bad [<rev>]
  21  git bisect good [<rev>...]
  22  git bisect skip [(<rev>|<range>)...]
  23  git bisect reset [<branch>]
  24  git bisect visualize
  25  git bisect replay <logfile>
  26  git bisect log
  27  git bisect run <cmd>...
  28
  29 This command uses 'git rev-list --bisect' to help drive the
  30 binary search process to find which change introduced a bug, given an
  31 old "good" commit object name and a later "bad" commit object name.
  32
  33 Getting help
  34 ~~~~~~~~~~~~
  35
  36 Use "git bisect" to get a short usage description, and "git bisect
  37 help" or "git bisect -h" to get a long usage description.
  38
  39 Basic bisect commands: start, bad, good
  40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  41
  42 Using the Linux kernel tree as an example, basic use of the bisect
  43 command is as follows:
  44
  45 ------------------------------------------------
  46 $ git bisect start
  47 $ git bisect bad                 # Current version is bad
  48 $ git bisect good v2.6.13-rc2    # v2.6.13-rc2 was the last version
  49                                  # tested that was good
  50 ------------------------------------------------
  51
  52 When you have specified at least one bad and one good version, the
  53 command bisects the revision tree and outputs something similar to
  54 the following:
  55
  56 ------------------------------------------------
  57 Bisecting: 675 revisions left to test after this
  58 ------------------------------------------------
  59
  60 The state in the middle of the set of revisions is then checked out.
  61 You would now compile that kernel and boot it. If the booted kernel
  62 works correctly, you would then issue the following command:
  63
  64 ------------------------------------------------
  65 $ git bisect good                       # this one is good
  66 ------------------------------------------------
  67
  68 The output of this command would be something similar to the following:
  69
  70 ------------------------------------------------
  71 Bisecting: 337 revisions left to test after this
  72 ------------------------------------------------
  73
  74 You keep repeating this process, compiling the tree, testing it, and
  75 depending on whether it is good or bad issuing the command "git bisect good"
  76 or "git bisect bad" to ask for the next bisection.
  77
  78 Eventually there will be no more revisions left to bisect, and you
  79 will have been left with the first bad kernel revision in "refs/bisect/bad".
  80
  81 Bisect reset
  82 ~~~~~~~~~~~~
  83
  84 To return to the original head after a bisect session, issue the
  85 following command:
  86
  87 ------------------------------------------------
  88 $ git bisect reset
  89 ------------------------------------------------
  90
  91 This resets the tree to the original branch instead of being on the
  92 bisection commit ("git bisect start" will also do that, as it resets
  93 the bisection state).
  94
  95 Bisect visualize
  96 ~~~~~~~~~~~~~~~~
  97
  98 To see the currently remaining suspects in 'gitk', issue the following
  99 command during the bisection process:
 100
 101 ------------
 102 $ git bisect visualize
 103 ------------
 104
 105 `view` may also be used as a synonym for `visualize`.
 106
 107 If the 'DISPLAY' environment variable is not set, 'git log' is used
 108 instead.  You can also give command line options such as `-p` and
 109 `--stat`.
 110
 111 ------------
 112 $ git bisect view --stat
 113 ------------
 114
 115 Bisect log and bisect replay
 116 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 117
 118 After having marked revisions as good or bad, issue the following
 119 command to show what has been done so far:
 120
 121 ------------
 122 $ git bisect log
 123 ------------
 124
 125 If you discover that you made a mistake in specifying the status of a
 126 revision, you can save the output of this command to a file, edit it to
 127 remove the incorrect entries, and then issue the following commands to
 128 return to a corrected state:
 129
 130 ------------
 131 $ git bisect reset
 132 $ git bisect replay that-file
 133 ------------
 134
 135 Avoiding testing a commit
 136 ~~~~~~~~~~~~~~~~~~~~~~~~~
 137
 138 If, in the middle of a bisect session, you know that the next suggested
 139 revision is not a good one to test (e.g. the change the commit
 140 introduces is known not to work in your environment and you know it
 141 does not have anything to do with the bug you are chasing), you may
 142 want to find a nearby commit and try that instead.
 143
 144 For example:
 145
 146 ------------
 147 $ git bisect good/bad                   # previous round was good or bad.
 148 Bisecting: 337 revisions left to test after this
 149 $ git bisect visualize                  # oops, that is uninteresting.
 150 $ git reset --hard HEAD~3               # try 3 revisions before what
 151                                         # was suggested
 152 ------------
 153
 154 Then compile and test the chosen revision, and afterwards mark
 155 the revision as good or bad in the usual manner.
 156
 157 Bisect skip
 158 ~~~~~~~~~~~~
 159
 160 Instead of choosing by yourself a nearby commit, you can ask git
 161 to do it for you by issuing the command:
 162
 163 ------------
 164 $ git bisect skip                 # Current version cannot be tested
 165 ------------
 166
 167 But git may eventually be unable to tell the first bad commit among
 168 a bad commit and one or more skipped commits.
 169
 170 You can even skip a range of commits, instead of just one commit,
 171 using the "'<commit1>'..'<commit2>'" notation. For example:
 172
 173 ------------
 174 $ git bisect skip v2.5..v2.6
 175 ------------
 176
 177 This tells the bisect process that no commit after `v2.5`, up to and
 178 including `v2.6`, should be tested.
 179
 180 Note that if you also want to skip the first commit of the range you
 181 would issue the command:
 182
 183 ------------
 184 $ git bisect skip v2.5 v2.5..v2.6
 185 ------------
 186
 187 This tells the bisect process that the commits between `v2.5` included
 188 and `v2.6` included should be skipped.
 189
 190
 191 Cutting down bisection by giving more parameters to bisect start
 192 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 193
 194 You can further cut down the number of trials, if you know what part of
 195 the tree is involved in the problem you are tracking down, by specifying
 196 path parameters when issuing the `bisect start` command:
 197
 198 ------------
 199 $ git bisect start -- arch/i386 include/asm-i386
 200 ------------
 201
 202 If you know beforehand more than one good commit, you can narrow the
 203 bisect space down by specifying all of the good commits immediately after
 204 the bad commit when issuing the `bisect start` command:
 205
 206 ------------
 207 $ git bisect start v2.6.20-rc6 v2.6.20-rc4 v2.6.20-rc1 --
 208                    # v2.6.20-rc6 is bad
 209                    # v2.6.20-rc4 and v2.6.20-rc1 are good
 210 ------------
 211
 212 Bisect run
 213 ~~~~~~~~~~
 214
 215 If you have a script that can tell if the current source code is good
 216 or bad, you can bisect by issuing the command:
 217
 218 ------------
 219 $ git bisect run my_script arguments
 220 ------------
 221
 222 Note that the script (`my_script` in the above example) should
 223 exit with code 0 if the current source code is good, and exit with a
 224 code between 1 and 127 (inclusive), except 125, if the current
 225 source code is bad.
 226
 227 Any other exit code will abort the bisect process. It should be noted
 228 that a program that terminates via "exit(-1)" leaves $? = 255, (see the
 229 exit(3) manual page), as the value is chopped with "& 0377".
 230
 231 The special exit code 125 should be used when the current source code
 232 cannot be tested. If the script exits with this code, the current
 233 revision will be skipped (see `git bisect skip` above).
 234
 235 You may often find that during a bisect session you want to have
 236 temporary modifications (e.g. s/#define DEBUG 0/#define DEBUG 1/ in a
 237 header file, or "revision that does not have this commit needs this
 238 patch applied to work around another problem this bisection is not
 239 interested in") applied to the revision being tested.
 240
 241 To cope with such a situation, after the inner 'git bisect' finds the
 242 next revision to test, the script can apply the patch
 243 before compiling, run the real test, and afterwards decide if the
 244 revision (possibly with the needed patch) passed the test and then
 245 rewind the tree to the pristine state.  Finally the script should exit
 246 with the status of the real test to let the "git bisect run" command loop
 247 determine the eventual outcome of the bisect session.
 248
 249 EXAMPLES
 250 --------
 251
 252 * Automatically bisect a broken build between v1.2 and HEAD:
 253 +
 254 ------------
 255 $ git bisect start HEAD v1.2 --      # HEAD is bad, v1.2 is good
 256 $ git bisect run make                # "make" builds the app
 257 ------------
 258
 259 * Automatically bisect a test failure between origin and HEAD:
 260 +
 261 ------------
 262 $ git bisect start HEAD origin --    # HEAD is bad, origin is good
 263 $ git bisect run make test           # "make test" builds and tests
 264 ------------
 265
 266 * Automatically bisect a broken test suite:
 267 +
 268 ------------
 269 $ cat ~/test.sh
 270 #!/bin/sh
 271 make || exit 125                   # this skips broken builds
 272 make test                          # "make test" runs the test suite
 273 $ git bisect start v1.3 v1.1 --    # v1.3 is bad, v1.1 is good
 274 $ git bisect run ~/test.sh
 275 ------------
 276 +
 277 Here we use a "test.sh" custom script. In this script, if "make"
 278 fails, we skip the current commit.
 279 +
 280 It is safer to use a custom script outside the repository to prevent
 281 interactions between the bisect, make and test processes and the
 282 script.
 283 +
 284 "make test" should "exit 0", if the test suite passes, and
 285 "exit 1" otherwise.
 286
 287 * Automatically bisect a broken test case:
 288 +
 289 ------------
 290 $ cat ~/test.sh
 291 #!/bin/sh
 292 make || exit 125                     # this skips broken builds
 293 ~/check_test_case.sh                 # does the test case passes ?
 294 $ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
 295 $ git bisect run ~/test.sh
 296 ------------
 297 +
 298 Here "check_test_case.sh" should "exit 0" if the test case passes,
 299 and "exit 1" otherwise.
 300 +
 301 It is safer if both "test.sh" and "check_test_case.sh" scripts are
 302 outside the repository to prevent interactions between the bisect,
 303 make and test processes and the scripts.
 304
 305 * Automatically bisect a broken test suite:
 306 +
 307 ------------
 308 $ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
 309 $ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"
 310 ------------
 311 +
 312 Does the same as the previous example, but on a single line.
 313
 314 Author
 315 ------
 316 Written by Linus Torvalds <torvalds@osdl.org>
 317
 318 Documentation
 319 -------------
 320 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 321
 322 GIT
 323 ---
 324 Part of the linkgit:git[1] suite