git-bisect.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.1" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-bisect(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-bisect(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-bisect -\r
 269    Find the change that introduced a bug\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <p><em>git bisect</em> &lt;subcommand&gt; &lt;options&gt;</p>\r
 276 </div>\r
 277 <h2>DESCRIPTION</h2>\r
 278 <div class="sectionbody">\r
 279 <p>The command takes various subcommands, and different options\r
 280 depending on the subcommand:</p>\r
 281 <div class="literalblock">\r
 282 <div class="content">\r
 283 <pre><tt>git bisect start [&lt;paths&gt;...]\r
 284 git bisect bad &lt;rev&gt;\r
 285 git bisect good &lt;rev&gt;\r
 286 git bisect reset [&lt;branch&gt;]\r
 287 git bisect visualize\r
 288 git bisect replay &lt;logfile&gt;\r
 289 git bisect log</tt></pre>\r
 290 </div></div>\r
 291 <p>This command uses <em>git-rev-list --bisect</em> option to help drive\r
 292 the binary search process to find which change introduced a bug,\r
 293 given an old "good" commit object name and a later "bad" commit\r
 294 object name.</p>\r
 295 <p>The way you use it is:</p>\r
 296 <div class="listingblock">\r
 297 <div class="content">\r
 298 <pre><tt>$ git bisect start\r
 299 $ git bisect bad                        # Current version is bad\r
 300 $ git bisect good v2.6.13-rc2           # v2.6.13-rc2 was the last version\r
 301                                         # tested that was good</tt></pre>\r
 302 </div></div>\r
 303 <p>When you give at least one bad and one good versions, it will\r
 304 bisect the revision tree and say something like:</p>\r
 305 <div class="listingblock">\r
 306 <div class="content">\r
 307 <pre><tt>Bisecting: 675 revisions left to test after this</tt></pre>\r
 308 </div></div>\r
 309 <p>and check out the state in the middle. Now, compile that kernel, and boot\r
 310 it. Now, let's say that this booted kernel works fine, then just do</p>\r
 311 <div class="listingblock">\r
 312 <div class="content">\r
 313 <pre><tt>$ git bisect good                       # this one is good</tt></pre>\r
 314 </div></div>\r
 315 <p>which will now say</p>\r
 316 <div class="listingblock">\r
 317 <div class="content">\r
 318 <pre><tt>Bisecting: 337 revisions left to test after this</tt></pre>\r
 319 </div></div>\r
 320 <p>and you continue along, compiling that one, testing it, and depending on\r
 321 whether it is good or bad, you say "git bisect good" or "git bisect bad",\r
 322 and ask for the next bisection.</p>\r
 323 <p>Until you have no more left, and you'll have been left with the first bad\r
 324 kernel rev in "refs/bisect/bad".</p>\r
 325 <p>Oh, and then after you want to reset to the original head, do a</p>\r
 326 <div class="listingblock">\r
 327 <div class="content">\r
 328 <pre><tt>$ git bisect reset</tt></pre>\r
 329 </div></div>\r
 330 <p>to get back to the master branch, instead of being in one of the bisection\r
 331 branches ("git bisect start" will do that for you too, actually: it will\r
 332 reset the bisection state, and before it does that it checks that you're\r
 333 not using some old bisection branch).</p>\r
 334 <p>During the bisection process, you can say</p>\r
 335 <div class="listingblock">\r
 336 <div class="content">\r
 337 <pre><tt>$ git bisect visualize</tt></pre>\r
 338 </div></div>\r
 339 <p>to see the currently remaining suspects in <tt>gitk</tt>.</p>\r
 340 <p>The good/bad input is logged, and <tt>git bisect\r
 341 log</tt> shows what you have done so far.  You can truncate its\r
 342 output somewhere and save it in a file, and run</p>\r
 343 <div class="listingblock">\r
 344 <div class="content">\r
 345 <pre><tt>$ git bisect replay that-file</tt></pre>\r
 346 </div></div>\r
 347 <p>if you find later you made a mistake telling good/bad about a\r
 348 revision.</p>\r
 349 <p>If in a middle of bisect session, you know what the bisect\r
 350 suggested to try next is not a good one to test (e.g. the change\r
 351 the commit introduces is known not to work in your environment\r
 352 and you know it does not have anything to do with the bug you\r
 353 are chasing), you may want to find a near-by commit and try that\r
 354 instead.  It goes something like this:</p>\r
 355 <div class="listingblock">\r
 356 <div class="content">\r
 357 <pre><tt>$ git bisect good/bad                   # previous round was good/bad.\r
 358 Bisecting: 337 revisions left to test after this\r
 359 $ git bisect visualize                  # oops, that is uninteresting.\r
 360 $ git reset --hard HEAD~3               # try 3 revs before what\r
 361                                         # was suggested</tt></pre>\r
 362 </div></div>\r
 363 <p>Then compile and test the one you chose to try.  After that,\r
 364 tell bisect what the result was as usual.</p>\r
 365 <p>You can further cut down the number of trials if you know what\r
 366 part of the tree is involved in the problem you are tracking\r
 367 down, by giving paths parameters when you say <tt>bisect start</tt>,\r
 368 like this:</p>\r
 369 <div class="listingblock">\r
 370 <div class="content">\r
 371 <pre><tt>$ git bisect start arch/i386 include/asm-i386</tt></pre>\r
 372 </div></div>\r
 373 </div>\r
 374 <h2>Author</h2>\r
 375 <div class="sectionbody">\r
 376 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
 377 </div>\r
 378 <h2>Documentation</h2>\r
 379 <div class="sectionbody">\r
 380 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 381 </div>\r
 382 <h2>GIT</h2>\r
 383 <div class="sectionbody">\r
 384 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 385 </div>\r
 386 <div id="footer">\r
 387 <div id="footer-text">\r
 388 Last updated 27-Dec-2005 00:15:48 PDT\r
 389 </div>\r
 390 </div>\r
 391 </body>\r
 392 </html>\r