Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| 2 | "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| 4 | <head> |
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 6 | <meta name="generator" content="AsciiDoc 8.5.2" /> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 7 | <title>git-bisect(1)</title> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 8 | <style type="text/css"> |
| 9 | /* Debug borders */ |
| 10 | p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { |
| 11 | /* |
| 12 | border: 1px solid red; |
| 13 | */ |
| 14 | } |
| 15 | |
| 16 | body { |
| 17 | margin: 1em 5% 1em 5%; |
| 18 | } |
| 19 | |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 20 | a { |
| 21 | color: blue; |
| 22 | text-decoration: underline; |
| 23 | } |
| 24 | a:visited { |
| 25 | color: fuchsia; |
| 26 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 27 | |
| 28 | em { |
| 29 | font-style: italic; |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 30 | color: navy; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 31 | } |
| 32 | |
| 33 | strong { |
| 34 | font-weight: bold; |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 35 | color: #083194; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 36 | } |
| 37 | |
| 38 | tt { |
| 39 | color: navy; |
| 40 | } |
| 41 | |
| 42 | h1, h2, h3, h4, h5, h6 { |
| 43 | color: #527bbd; |
| 44 | font-family: sans-serif; |
| 45 | margin-top: 1.2em; |
| 46 | margin-bottom: 0.5em; |
| 47 | line-height: 1.3; |
| 48 | } |
| 49 | |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 50 | h1, h2, h3 { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 51 | border-bottom: 2px solid silver; |
| 52 | } |
| 53 | h2 { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 54 | padding-top: 0.5em; |
| 55 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 56 | h3 { |
| 57 | float: left; |
| 58 | } |
| 59 | h3 + * { |
| 60 | clear: left; |
| 61 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 62 | |
| 63 | div.sectionbody { |
| 64 | font-family: serif; |
| 65 | margin-left: 0; |
| 66 | } |
| 67 | |
| 68 | hr { |
| 69 | border: 1px solid silver; |
| 70 | } |
| 71 | |
| 72 | p { |
| 73 | margin-top: 0.5em; |
| 74 | margin-bottom: 0.5em; |
| 75 | } |
| 76 | |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 77 | ul, ol, li > p { |
| 78 | margin-top: 0; |
| 79 | } |
| 80 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 81 | pre { |
| 82 | padding: 0; |
| 83 | margin: 0; |
| 84 | } |
| 85 | |
| 86 | span#author { |
| 87 | color: #527bbd; |
| 88 | font-family: sans-serif; |
| 89 | font-weight: bold; |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 90 | font-size: 1.1em; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 91 | } |
| 92 | span#email { |
| 93 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 94 | span#revnumber, span#revdate, span#revremark { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 95 | font-family: sans-serif; |
| 96 | } |
| 97 | |
| 98 | div#footer { |
| 99 | font-family: sans-serif; |
| 100 | font-size: small; |
| 101 | border-top: 2px solid silver; |
| 102 | padding-top: 0.5em; |
| 103 | margin-top: 4.0em; |
| 104 | } |
| 105 | div#footer-text { |
| 106 | float: left; |
| 107 | padding-bottom: 0.5em; |
| 108 | } |
| 109 | div#footer-badges { |
| 110 | float: right; |
| 111 | padding-bottom: 0.5em; |
| 112 | } |
| 113 | |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 114 | div#preamble { |
| 115 | margin-top: 1.5em; |
| 116 | margin-bottom: 1.5em; |
| 117 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 118 | div.tableblock, div.imageblock, div.exampleblock, div.verseblock, |
| 119 | div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, |
| 120 | div.admonitionblock { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 121 | margin-top: 1.0em; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 122 | margin-bottom: 1.5em; |
| 123 | } |
| 124 | div.admonitionblock { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 125 | margin-top: 2.0em; |
| 126 | margin-bottom: 2.0em; |
| 127 | margin-right: 10%; |
| 128 | color: #606060; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | div.content { /* Block element content. */ |
| 132 | padding: 0; |
| 133 | } |
| 134 | |
| 135 | /* Block element titles. */ |
| 136 | div.title, caption.title { |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 137 | color: #527bbd; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 138 | font-family: sans-serif; |
| 139 | font-weight: bold; |
| 140 | text-align: left; |
| 141 | margin-top: 1.0em; |
| 142 | margin-bottom: 0.5em; |
| 143 | } |
| 144 | div.title + * { |
| 145 | margin-top: 0; |
| 146 | } |
| 147 | |
| 148 | td div.title:first-child { |
| 149 | margin-top: 0.0em; |
| 150 | } |
| 151 | div.content div.title:first-child { |
| 152 | margin-top: 0.0em; |
| 153 | } |
| 154 | div.content + div.title { |
| 155 | margin-top: 0.0em; |
| 156 | } |
| 157 | |
| 158 | div.sidebarblock > div.content { |
| 159 | background: #ffffee; |
| 160 | border: 1px solid silver; |
| 161 | padding: 0.5em; |
| 162 | } |
| 163 | |
| 164 | div.listingblock > div.content { |
| 165 | border: 1px solid silver; |
| 166 | background: #f4f4f4; |
| 167 | padding: 0.5em; |
| 168 | } |
| 169 | |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 170 | div.quoteblock, div.verseblock { |
| 171 | padding-left: 1.0em; |
| 172 | margin-left: 1.0em; |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 173 | margin-right: 10%; |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 174 | border-left: 5px solid #dddddd; |
| 175 | color: #777777; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 176 | } |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 177 | |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 178 | div.quoteblock > div.attribution { |
| 179 | padding-top: 0.5em; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 180 | text-align: right; |
| 181 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 182 | |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 183 | div.verseblock > div.content { |
| 184 | white-space: pre; |
| 185 | } |
| 186 | div.verseblock > div.attribution { |
| 187 | padding-top: 0.75em; |
| 188 | text-align: left; |
| 189 | } |
| 190 | /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 191 | div.verseblock + div.attribution { |
| 192 | text-align: left; |
| 193 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 194 | |
| 195 | div.admonitionblock .icon { |
| 196 | vertical-align: top; |
| 197 | font-size: 1.1em; |
| 198 | font-weight: bold; |
| 199 | text-decoration: underline; |
| 200 | color: #527bbd; |
| 201 | padding-right: 0.5em; |
| 202 | } |
| 203 | div.admonitionblock td.content { |
| 204 | padding-left: 0.5em; |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 205 | border-left: 3px solid #dddddd; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 206 | } |
| 207 | |
| 208 | div.exampleblock > div.content { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 209 | border-left: 3px solid #dddddd; |
| 210 | padding-left: 0.5em; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 211 | } |
| 212 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 213 | div.imageblock div.content { padding-left: 0; } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 214 | span.image img { border-style: none; } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 215 | a.image:visited { color: white; } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 216 | |
| 217 | dl { |
| 218 | margin-top: 0.8em; |
| 219 | margin-bottom: 0.8em; |
| 220 | } |
| 221 | dt { |
| 222 | margin-top: 0.5em; |
| 223 | margin-bottom: 0; |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 224 | font-style: normal; |
| 225 | color: navy; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 226 | } |
| 227 | dd > *:first-child { |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 228 | margin-top: 0.1em; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 229 | } |
| 230 | |
| 231 | ul, ol { |
| 232 | list-style-position: outside; |
| 233 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 234 | ol.arabic { |
| 235 | list-style-type: decimal; |
| 236 | } |
| 237 | ol.loweralpha { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 238 | list-style-type: lower-alpha; |
| 239 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 240 | ol.upperalpha { |
| 241 | list-style-type: upper-alpha; |
| 242 | } |
| 243 | ol.lowerroman { |
| 244 | list-style-type: lower-roman; |
| 245 | } |
| 246 | ol.upperroman { |
| 247 | list-style-type: upper-roman; |
| 248 | } |
| 249 | |
| 250 | div.compact ul, div.compact ol, |
| 251 | div.compact p, div.compact p, |
| 252 | div.compact div, div.compact div { |
| 253 | margin-top: 0.1em; |
| 254 | margin-bottom: 0.1em; |
| 255 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 256 | |
| 257 | div.tableblock > table { |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 258 | border: 3px solid #527bbd; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 259 | } |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 260 | thead, p.table.header { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 261 | font-family: sans-serif; |
| 262 | font-weight: bold; |
| 263 | } |
| 264 | tfoot { |
| 265 | font-weight: bold; |
| 266 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 267 | td > div.verse { |
| 268 | white-space: pre; |
| 269 | } |
| 270 | p.table { |
| 271 | margin-top: 0; |
| 272 | } |
| 273 | /* Because the table frame attribute is overriden by CSS in most browsers. */ |
| 274 | div.tableblock > table[frame="void"] { |
| 275 | border-style: none; |
| 276 | } |
| 277 | div.tableblock > table[frame="hsides"] { |
| 278 | border-left-style: none; |
| 279 | border-right-style: none; |
| 280 | } |
| 281 | div.tableblock > table[frame="vsides"] { |
| 282 | border-top-style: none; |
| 283 | border-bottom-style: none; |
| 284 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 285 | |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 286 | |
| 287 | div.hdlist { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 288 | margin-top: 0.8em; |
| 289 | margin-bottom: 0.8em; |
| 290 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 291 | div.hdlist tr { |
| 292 | padding-bottom: 15px; |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 293 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 294 | dt.hdlist1.strong, td.hdlist1.strong { |
| 295 | font-weight: bold; |
| 296 | } |
| 297 | td.hdlist1 { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 298 | vertical-align: top; |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 299 | font-style: normal; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 300 | padding-right: 0.8em; |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 301 | color: navy; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 302 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 303 | td.hdlist2 { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 304 | vertical-align: top; |
| 305 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 306 | div.hdlist.compact tr { |
| 307 | margin: 0; |
| 308 | padding-bottom: 0; |
| 309 | } |
| 310 | |
| 311 | .comment { |
| 312 | background: yellow; |
| 313 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 314 | |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 315 | .footnote, .footnoteref { |
| 316 | font-size: 0.8em; |
| 317 | } |
| 318 | |
| 319 | span.footnote, span.footnoteref { |
| 320 | vertical-align: super; |
| 321 | } |
| 322 | |
| 323 | #footnotes { |
| 324 | margin: 20px 0 20px 0; |
| 325 | padding: 7px 0 0 0; |
| 326 | } |
| 327 | |
| 328 | #footnotes div.footnote { |
| 329 | margin: 0 0 5px 0; |
| 330 | } |
| 331 | |
| 332 | #footnotes hr { |
| 333 | border: none; |
| 334 | border-top: 1px solid silver; |
| 335 | height: 1px; |
| 336 | text-align: left; |
| 337 | margin-left: 0; |
| 338 | width: 20%; |
| 339 | min-width: 100px; |
| 340 | } |
| 341 | |
| 342 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 343 | @media print { |
| 344 | div#footer-badges { display: none; } |
| 345 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 346 | |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 347 | div#toc { |
| 348 | margin-bottom: 2.5em; |
| 349 | } |
| 350 | |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 351 | div#toctitle { |
| 352 | color: #527bbd; |
| 353 | font-family: sans-serif; |
| 354 | font-size: 1.1em; |
| 355 | font-weight: bold; |
| 356 | margin-top: 1.0em; |
| 357 | margin-bottom: 0.1em; |
| 358 | } |
| 359 | |
| 360 | div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { |
| 361 | margin-top: 0; |
| 362 | margin-bottom: 0; |
| 363 | } |
| 364 | div.toclevel2 { |
| 365 | margin-left: 2em; |
| 366 | font-size: 0.9em; |
| 367 | } |
| 368 | div.toclevel3 { |
| 369 | margin-left: 4em; |
| 370 | font-size: 0.9em; |
| 371 | } |
| 372 | div.toclevel4 { |
| 373 | margin-left: 6em; |
| 374 | font-size: 0.9em; |
| 375 | } |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 376 | /* Overrides for manpage documents */ |
| 377 | h1 { |
| 378 | padding-top: 0.5em; |
| 379 | padding-bottom: 0.5em; |
| 380 | border-top: 2px solid silver; |
| 381 | border-bottom: 2px solid silver; |
| 382 | } |
| 383 | h2 { |
| 384 | border-style: none; |
| 385 | } |
| 386 | div.sectionbody { |
| 387 | margin-left: 5%; |
| 388 | } |
| 389 | |
| 390 | @media print { |
| 391 | div#toc { display: none; } |
| 392 | } |
| 393 | |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 394 | /* Workarounds for IE6's broken and incomplete CSS2. */ |
| 395 | |
| 396 | div.sidebar-content { |
| 397 | background: #ffffee; |
| 398 | border: 1px solid silver; |
| 399 | padding: 0.5em; |
| 400 | } |
| 401 | div.sidebar-title, div.image-title { |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 402 | color: #527bbd; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 403 | font-family: sans-serif; |
| 404 | font-weight: bold; |
| 405 | margin-top: 0.0em; |
| 406 | margin-bottom: 0.5em; |
| 407 | } |
| 408 | |
| 409 | div.listingblock div.content { |
| 410 | border: 1px solid silver; |
| 411 | background: #f4f4f4; |
| 412 | padding: 0.5em; |
| 413 | } |
| 414 | |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 415 | div.quoteblock-attribution { |
| 416 | padding-top: 0.5em; |
| 417 | text-align: right; |
| 418 | } |
| 419 | |
| 420 | div.verseblock-content { |
| 421 | white-space: pre; |
| 422 | } |
| 423 | div.verseblock-attribution { |
| 424 | padding-top: 0.75em; |
| 425 | text-align: left; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 426 | } |
| 427 | |
| 428 | div.exampleblock-content { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 429 | border-left: 3px solid #dddddd; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 430 | padding-left: 0.5em; |
| 431 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 432 | |
| 433 | /* IE6 sets dynamically generated links as visited. */ |
| 434 | div#toc a:visited { color: blue; } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 435 | </style> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 436 | <script type="text/javascript"> |
| 437 | /*<+'])'); |
| 481 | // Function that scans the DOM tree for header elements (the DOM2 |
| 482 | // nodeIterator API would be a better technique but not supported by all |
| 483 | // browsers). |
| 484 | var iterate = function (el) { |
| 485 | for (var i = el.firstChild; i != null; i = i.nextSibling) { |
| 486 | if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { |
| 487 | var mo = re.exec(i.tagName); |
| 488 | if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { |
| 489 | result[result.length] = new TocEntry(i, getText(i), mo[1]-1); |
| 490 | } |
| 491 | iterate(i); |
| 492 | } |
| 493 | } |
| 494 | } |
| 495 | iterate(el); |
| 496 | return result; |
| 497 | } |
| 498 | |
| 499 | var toc = document.getElementById("toc"); |
| 500 | var entries = tocEntries(document.getElementById("content"), toclevels); |
| 501 | for (var i = 0; i < entries.length; ++i) { |
| 502 | var entry = entries[i]; |
| 503 | if (entry.element.id == "") |
| 504 | entry.element.id = "_toc_" + i; |
| 505 | var a = document.createElement("a"); |
| 506 | a.href = "#" + entry.element.id; |
| 507 | a.appendChild(document.createTextNode(entry.text)); |
| 508 | var div = document.createElement("div"); |
| 509 | div.appendChild(a); |
| 510 | div.className = "toclevel" + entry.toclevel; |
| 511 | toc.appendChild(div); |
| 512 | } |
| 513 | if (entries.length == 0) |
| 514 | toc.parentNode.removeChild(toc); |
| 515 | }, |
| 516 | |
| 517 | |
| 518 | ///////////////////////////////////////////////////////////////////// |
| 519 | // Footnotes generator |
| 520 | ///////////////////////////////////////////////////////////////////// |
| 521 | |
| 522 | /* Based on footnote generation code from: |
| 523 | * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html |
| 524 | */ |
| 525 | |
| 526 | footnotes: function () { |
| 527 | var cont = document.getElementById("content"); |
| 528 | var noteholder = document.getElementById("footnotes"); |
| 529 | var spans = cont.getElementsByTagName("span"); |
| 530 | var refs = {}; |
| 531 | var n = 0; |
| 532 | for (i=0; i<spans.length; i++) { |
| 533 | if (spans[i].className == "footnote") { |
| 534 | n++; |
| 535 | // Use [\s\S] in place of . so multi-line matches work. |
| 536 | // Because JavaScript has no s (dotall) regex flag. |
| 537 | note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; |
| 538 | noteholder.innerHTML += |
| 539 | "<div class='footnote' id='_footnote_" + n + "'>" + |
| 540 | "<a href='#_footnoteref_" + n + "' title='Return to text'>" + |
| 541 | n + "</a>. " + note + "</div>"; |
| 542 | spans[i].innerHTML = |
| 543 | "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + |
| 544 | "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 545 | var id =spans[i].getAttribute("id"); |
| 546 | if (id != null) refs["#"+id] = n; |
| 547 | } |
| 548 | } |
| 549 | if (n == 0) |
| 550 | noteholder.parentNode.removeChild(noteholder); |
| 551 | else { |
| 552 | // Process footnoterefs. |
| 553 | for (i=0; i<spans.length; i++) { |
| 554 | if (spans[i].className == "footnoteref") { |
| 555 | var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); |
| 556 | href = href.match(/#.*/)[0]; // Because IE return full URL. |
| 557 | n = refs[href]; |
| 558 | spans[i].innerHTML = |
| 559 | "[<a href='#_footnote_" + n + |
| 560 | "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 561 | } |
| 562 | } |
| 563 | } |
| 564 | } |
| 565 | |
| 566 | } |
| 567 | /*]]>*/ |
| 568 | </script> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 569 | </head> |
| 570 | <body> |
| 571 | <div id="header"> |
| 572 | <h1> |
| 573 | git-bisect(1) Manual Page |
| 574 | </h1> |
| 575 | <h2>NAME</h2> |
| 576 | <div class="sectionbody"> |
| 577 | <p>git-bisect - |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 578 | Find by binary search the change that introduced a bug |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 579 | </p> |
| 580 | </div> |
| 581 | </div> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 582 | <div id="content"> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 583 | <h2 id="_synopsis">SYNOPSIS</h2> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 584 | <div class="sectionbody"> |
Junio C Hamano | 15567bc | 2011-07-23 00:51:59 | [diff] [blame] | 585 | <div class="verseblock"> |
| 586 | <div class="verseblock-content"><em>git bisect</em> <subcommand> <options></div> |
| 587 | <div class="verseblock-attribution"> |
| 588 | </div></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 589 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 590 | <h2 id="_description">DESCRIPTION</h2> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 591 | <div class="sectionbody"> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 592 | <div class="paragraph"><p>The command takes various subcommands, and different options depending |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 593 | on the subcommand:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 594 | <div class="literalblock"> |
| 595 | <div class="content"> |
Junio C Hamano | e79159d | 2008-04-12 08:23:17 | [diff] [blame] | 596 | <pre><tt>git bisect help |
Junio C Hamano | f727901 | 2011-08-18 06:13:13 | [diff] [blame] | 597 | git bisect start [--no-checkout] [<bad> [<good>...]] [--] [<paths>...] |
Junio C Hamano | 1974bf2 | 2007-10-31 05:57:20 | [diff] [blame] | 598 | git bisect bad [<rev>] |
| 599 | git bisect good [<rev>...] |
Junio C Hamano | d796cea | 2008-12-03 03:51:10 | [diff] [blame] | 600 | git bisect skip [(<rev>|<range>)...] |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 601 | git bisect reset [<commit>] |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 602 | git bisect visualize |
| 603 | git bisect replay <logfile> |
Junio C Hamano | f440a23 | 2007-03-23 10:46:17 | [diff] [blame] | 604 | git bisect log |
| 605 | git bisect run <cmd>...</tt></pre> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 606 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 607 | <div class="paragraph"><p>This command uses <em>git rev-list --bisect</em> to help drive the |
Junio C Hamano | b60308a | 2007-03-24 07:16:42 | [diff] [blame] | 608 | binary search process to find which change introduced a bug, given an |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 609 | old "good" commit object name and a later "bad" commit object name.</p></div> |
| 610 | <h3 id="_getting_help">Getting help</h3><div style="clear:left"></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 611 | <div class="paragraph"><p>Use "git bisect" to get a short usage description, and "git bisect |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 612 | help" or "git bisect -h" to get a long usage description.</p></div> |
| 613 | <h3 id="_basic_bisect_commands_start_bad_good">Basic bisect commands: start, bad, good</h3><div style="clear:left"></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 614 | <div class="paragraph"><p>Using the Linux kernel tree as an example, basic use of the bisect |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 615 | command is as follows:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 616 | <div class="listingblock"> |
| 617 | <div class="content"> |
| 618 | <pre><tt>$ git bisect start |
Junio C Hamano | b60308a | 2007-03-24 07:16:42 | [diff] [blame] | 619 | $ git bisect bad # Current version is bad |
| 620 | $ git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version |
| 621 | # tested that was good</tt></pre> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 622 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 623 | <div class="paragraph"><p>When you have specified at least one bad and one good version, the |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 624 | command bisects the revision tree and outputs something similar to |
| 625 | the following:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 626 | <div class="listingblock"> |
| 627 | <div class="content"> |
| 628 | <pre><tt>Bisecting: 675 revisions left to test after this</tt></pre> |
| 629 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 630 | <div class="paragraph"><p>The state in the middle of the set of revisions is then checked out. |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 631 | You would now compile that kernel and boot it. If the booted kernel |
| 632 | works correctly, you would then issue the following command:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 633 | <div class="listingblock"> |
| 634 | <div class="content"> |
| 635 | <pre><tt>$ git bisect good # this one is good</tt></pre> |
| 636 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 637 | <div class="paragraph"><p>The output of this command would be something similar to the following:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 638 | <div class="listingblock"> |
| 639 | <div class="content"> |
| 640 | <pre><tt>Bisecting: 337 revisions left to test after this</tt></pre> |
| 641 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 642 | <div class="paragraph"><p>You keep repeating this process, compiling the tree, testing it, and |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 643 | depending on whether it is good or bad issuing the command "git bisect good" |
| 644 | or "git bisect bad" to ask for the next bisection.</p></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 645 | <div class="paragraph"><p>Eventually there will be no more revisions left to bisect, and you |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 646 | will have been left with the first bad kernel revision in "refs/bisect/bad".</p></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 647 | <h3 id="_bisect_reset">Bisect reset</h3><div style="clear:left"></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 648 | <div class="paragraph"><p>After a bisect session, to clean up the bisection state and return to |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 649 | the original HEAD, issue the following command:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 650 | <div class="listingblock"> |
| 651 | <div class="content"> |
| 652 | <pre><tt>$ git bisect reset</tt></pre> |
| 653 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 654 | <div class="paragraph"><p>By default, this will return your tree to the commit that was checked |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 655 | out before <tt>git bisect start</tt>. (A new <tt>git bisect start</tt> will also do |
| 656 | that, as it cleans up the old bisection state.)</p></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 657 | <div class="paragraph"><p>With an optional argument, you can return to a different commit |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 658 | instead:</p></div> |
| 659 | <div class="listingblock"> |
| 660 | <div class="content"> |
| 661 | <pre><tt>$ git bisect reset <commit></tt></pre> |
| 662 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 663 | <div class="paragraph"><p>For example, <tt>git bisect reset HEAD</tt> will leave you on the current |
Junio C Hamano | c21ab05 | 2009-10-31 04:03:55 | [diff] [blame] | 664 | bisection commit and avoid switching commits at all, while <tt>git bisect |
| 665 | reset bisect/bad</tt> will check out the first bad revision.</p></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 666 | <h3 id="_bisect_visualize">Bisect visualize</h3><div style="clear:left"></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 667 | <div class="paragraph"><p>To see the currently remaining suspects in <em>gitk</em>, issue the following |
Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 668 | command during the bisection process:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 669 | <div class="listingblock"> |
| 670 | <div class="content"> |
| 671 | <pre><tt>$ git bisect visualize</tt></pre> |
| 672 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 673 | <div class="paragraph"><p><tt>view</tt> may also be used as a synonym for <tt>visualize</tt>.</p></div> |
| 674 | <div class="paragraph"><p>If the <em>DISPLAY</em> environment variable is not set, <em>git log</em> is used |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 675 | instead. You can also give command line options such as <tt>-p</tt> and |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 676 | <tt>--stat</tt>.</p></div> |
Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 677 | <div class="listingblock"> |
| 678 | <div class="content"> |
| 679 | <pre><tt>$ git bisect view --stat</tt></pre> |
| 680 | </div></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 681 | <h3 id="_bisect_log_and_bisect_replay">Bisect log and bisect replay</h3><div style="clear:left"></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 682 | <div class="paragraph"><p>After having marked revisions as good or bad, issue the following |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 683 | command to show what has been done so far:</p></div> |
Junio C Hamano | b60308a | 2007-03-24 07:16:42 | [diff] [blame] | 684 | <div class="listingblock"> |
| 685 | <div class="content"> |
| 686 | <pre><tt>$ git bisect log</tt></pre> |
| 687 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 688 | <div class="paragraph"><p>If you discover that you made a mistake in specifying the status of a |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 689 | revision, you can save the output of this command to a file, edit it to |
| 690 | remove the incorrect entries, and then issue the following commands to |
| 691 | return to a corrected state:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 692 | <div class="listingblock"> |
| 693 | <div class="content"> |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 694 | <pre><tt>$ git bisect reset |
| 695 | $ git bisect replay that-file</tt></pre> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 696 | </div></div> |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 697 | <h3 id="_avoiding_testing_a_commit">Avoiding testing a commit</h3><div style="clear:left"></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 698 | <div class="paragraph"><p>If, in the middle of a bisect session, you know that the next suggested |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 699 | revision is not a good one to test (e.g. the change the commit |
Junio C Hamano | b60308a | 2007-03-24 07:16:42 | [diff] [blame] | 700 | introduces is known not to work in your environment and you know it |
| 701 | does not have anything to do with the bug you are chasing), you may |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 702 | want to find a nearby commit and try that instead.</p></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 703 | <div class="paragraph"><p>For example:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 704 | <div class="listingblock"> |
| 705 | <div class="content"> |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 706 | <pre><tt>$ git bisect good/bad # previous round was good or bad. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 707 | Bisecting: 337 revisions left to test after this |
| 708 | $ git bisect visualize # oops, that is uninteresting. |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 709 | $ git reset --hard HEAD~3 # try 3 revisions before what |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 710 | # was suggested</tt></pre> |
| 711 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 712 | <div class="paragraph"><p>Then compile and test the chosen revision, and afterwards mark |
Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 713 | the revision as good or bad in the usual manner.</p></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 714 | <h3 id="_bisect_skip">Bisect skip</h3><div style="clear:left"></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 715 | <div class="paragraph"><p>Instead of choosing by yourself a nearby commit, you can ask git |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 716 | to do it for you by issuing the command:</p></div> |
Junio C Hamano | 1974bf2 | 2007-10-31 05:57:20 | [diff] [blame] | 717 | <div class="listingblock"> |
| 718 | <div class="content"> |
| 719 | <pre><tt>$ git bisect skip # Current version cannot be tested</tt></pre> |
| 720 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 721 | <div class="paragraph"><p>But git may eventually be unable to tell the first bad commit among |
Junio C Hamano | 2c14c8d | 2009-07-02 03:17:00 | [diff] [blame] | 722 | a bad commit and one or more skipped commits.</p></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 723 | <div class="paragraph"><p>You can even skip a range of commits, instead of just one commit, |
Junio C Hamano | d796cea | 2008-12-03 03:51:10 | [diff] [blame] | 724 | using the "<em><commit1></em>..<em><commit2></em>" notation. For example:</p></div> |
| 725 | <div class="listingblock"> |
| 726 | <div class="content"> |
| 727 | <pre><tt>$ git bisect skip v2.5..v2.6</tt></pre> |
| 728 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 729 | <div class="paragraph"><p>This tells the bisect process that no commit after <tt>v2.5</tt>, up to and |
Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 730 | including <tt>v2.6</tt>, should be tested.</p></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 731 | <div class="paragraph"><p>Note that if you also want to skip the first commit of the range you |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 732 | would issue the command:</p></div> |
Junio C Hamano | d796cea | 2008-12-03 03:51:10 | [diff] [blame] | 733 | <div class="listingblock"> |
| 734 | <div class="content"> |
| 735 | <pre><tt>$ git bisect skip v2.5 v2.5..v2.6</tt></pre> |
| 736 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 737 | <div class="paragraph"><p>This tells the bisect process that the commits between <tt>v2.5</tt> included |
Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 738 | and <tt>v2.6</tt> included should be skipped.</p></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 739 | <h3 id="_cutting_down_bisection_by_giving_more_parameters_to_bisect_start">Cutting down bisection by giving more parameters to bisect start</h3><div style="clear:left"></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 740 | <div class="paragraph"><p>You can further cut down the number of trials, if you know what part of |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 741 | the tree is involved in the problem you are tracking down, by specifying |
| 742 | path parameters when issuing the <tt>bisect start</tt> command:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 743 | <div class="listingblock"> |
| 744 | <div class="content"> |
Junio C Hamano | 12a3a23 | 2007-04-07 10:18:10 | [diff] [blame] | 745 | <pre><tt>$ git bisect start -- arch/i386 include/asm-i386</tt></pre> |
| 746 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 747 | <div class="paragraph"><p>If you know beforehand more than one good commit, you can narrow the |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 748 | bisect space down by specifying all of the good commits immediately after |
| 749 | the bad commit when issuing the <tt>bisect start</tt> command:</p></div> |
Junio C Hamano | 12a3a23 | 2007-04-07 10:18:10 | [diff] [blame] | 750 | <div class="listingblock"> |
| 751 | <div class="content"> |
| 752 | <pre><tt>$ git bisect start v2.6.20-rc6 v2.6.20-rc4 v2.6.20-rc1 -- |
| 753 | # v2.6.20-rc6 is bad |
| 754 | # v2.6.20-rc4 and v2.6.20-rc1 are good</tt></pre> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 755 | </div></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 756 | <h3 id="_bisect_run">Bisect run</h3><div style="clear:left"></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 757 | <div class="paragraph"><p>If you have a script that can tell if the current source code is good |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 758 | or bad, you can bisect by issuing the command:</p></div> |
Junio C Hamano | f440a23 | 2007-03-23 10:46:17 | [diff] [blame] | 759 | <div class="listingblock"> |
| 760 | <div class="content"> |
Junio C Hamano | 0a23522 | 2009-03-06 08:21:09 | [diff] [blame] | 761 | <pre><tt>$ git bisect run my_script arguments</tt></pre> |
Junio C Hamano | f440a23 | 2007-03-23 10:46:17 | [diff] [blame] | 762 | </div></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 763 | <div class="paragraph"><p>Note that the script (<tt>my_script</tt> in the above example) should |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 764 | exit with code 0 if the current source code is good, and exit with a |
Junio C Hamano | 1974bf2 | 2007-10-31 05:57:20 | [diff] [blame] | 765 | code between 1 and 127 (inclusive), except 125, if the current |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 766 | source code is bad.</p></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 767 | <div class="paragraph"><p>Any other exit code will abort the bisect process. It should be noted |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 768 | that a program that terminates via "exit(-1)" leaves $? = 255, (see the |
| 769 | exit(3) manual page), as the value is chopped with "& 0377".</p></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 770 | <div class="paragraph"><p>The special exit code 125 should be used when the current source code |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 771 | cannot be tested. If the script exits with this code, the current |
Junio C Hamano | d2c978f | 2011-03-20 19:42:22 | [diff] [blame] | 772 | revision will be skipped (see <tt>git bisect skip</tt> above). 125 was chosen |
| 773 | as the highest sensible value to use for this purpose, because 126 and 127 |
| 774 | are used by POSIX shells to signal specific error status (127 is for |
| 775 | command not found, 126 is for command found but not executable---these |
| 776 | details do not matter, as they are normal errors in the script, as far as |
| 777 | "bisect run" is concerned).</p></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 778 | <div class="paragraph"><p>You may often find that during a bisect session you want to have |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 779 | temporary modifications (e.g. s/#define DEBUG 0/#define DEBUG 1/ in a |
| 780 | header file, or "revision that does not have this commit needs this |
| 781 | patch applied to work around another problem this bisection is not |
| 782 | interested in") applied to the revision being tested.</p></div> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 783 | <div class="paragraph"><p>To cope with such a situation, after the inner <em>git bisect</em> finds the |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 784 | next revision to test, the script can apply the patch |
| 785 | before compiling, run the real test, and afterwards decide if the |
| 786 | revision (possibly with the needed patch) passed the test and then |
| 787 | rewind the tree to the pristine state. Finally the script should exit |
| 788 | with the status of the real test to let the "git bisect run" command loop |
| 789 | determine the eventual outcome of the bisect session.</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 790 | </div> |
Junio C Hamano | f727901 | 2011-08-18 06:13:13 | [diff] [blame] | 791 | <h2 id="_options">OPTIONS</h2> |
| 792 | <div class="sectionbody"> |
| 793 | <div class="dlist"><dl> |
| 794 | <dt class="hdlist1"> |
| 795 | --no-checkout |
| 796 | </dt> |
| 797 | <dd> |
| 798 | <div class="paragraph"><p>Do not checkout the new working tree at each iteration of the bisection |
| 799 | process. Instead just update a special reference named <em>BISECT_HEAD</em> to make |
| 800 | it point to the commit that should be tested.</p></div> |
| 801 | <div class="paragraph"><p>This option may be useful when the test you would perform in each step |
| 802 | does not require a checked out tree.</p></div> |
| 803 | <div class="paragraph"><p>If the repository is bare, <tt>--no-checkout</tt> is assumed.</p></div> |
| 804 | </dd> |
| 805 | </dl></div> |
| 806 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 807 | <h2 id="_examples">EXAMPLES</h2> |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 808 | <div class="sectionbody"> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 809 | <div class="ulist"><ul> |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 810 | <li> |
| 811 | <p> |
| 812 | Automatically bisect a broken build between v1.2 and HEAD: |
| 813 | </p> |
| 814 | <div class="listingblock"> |
| 815 | <div class="content"> |
| 816 | <pre><tt>$ git bisect start HEAD v1.2 -- # HEAD is bad, v1.2 is good |
| 817 | $ git bisect run make # "make" builds the app</tt></pre> |
| 818 | </div></div> |
| 819 | </li> |
| 820 | <li> |
| 821 | <p> |
Junio C Hamano | 0a23522 | 2009-03-06 08:21:09 | [diff] [blame] | 822 | Automatically bisect a test failure between origin and HEAD: |
| 823 | </p> |
| 824 | <div class="listingblock"> |
| 825 | <div class="content"> |
| 826 | <pre><tt>$ git bisect start HEAD origin -- # HEAD is bad, origin is good |
| 827 | $ git bisect run make test # "make test" builds and tests</tt></pre> |
| 828 | </div></div> |
| 829 | </li> |
| 830 | <li> |
| 831 | <p> |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 832 | Automatically bisect a broken test case: |
| 833 | </p> |
| 834 | <div class="listingblock"> |
| 835 | <div class="content"> |
| 836 | <pre><tt>$ cat ~/test.sh |
| 837 | #!/bin/sh |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 838 | make || exit 125 # this skips broken builds |
Junio C Hamano | 9a2fb2d | 2011-03-23 05:40:15 | [diff] [blame] | 839 | ~/check_test_case.sh # does the test case pass? |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 840 | $ git bisect start HEAD HEAD~10 -- # culprit is among the last 10 |
| 841 | $ git bisect run ~/test.sh</tt></pre> |
| 842 | </div></div> |
Junio C Hamano | 9a2fb2d | 2011-03-23 05:40:15 | [diff] [blame] | 843 | <div class="paragraph"><p>Here we use a "test.sh" custom script. In this script, if "make" |
| 844 | fails, we skip the current commit. |
| 845 | "check_test_case.sh" should "exit 0" if the test case passes, |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 846 | and "exit 1" otherwise.</p></div> |
Junio C Hamano | 9a2fb2d | 2011-03-23 05:40:15 | [diff] [blame] | 847 | <div class="paragraph"><p>It is safer if both "test.sh" and "check_test_case.sh" are |
Junio C Hamano | fd83b8e | 2009-03-22 08:21:41 | [diff] [blame] | 848 | outside the repository to prevent interactions between the bisect, |
| 849 | make and test processes and the scripts.</p></div> |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 850 | </li> |
Junio C Hamano | 0a23522 | 2009-03-06 08:21:09 | [diff] [blame] | 851 | <li> |
| 852 | <p> |
Junio C Hamano | 9a2fb2d | 2011-03-23 05:40:15 | [diff] [blame] | 853 | Automatically bisect with temporary modifications (hot-fix): |
| 854 | </p> |
| 855 | <div class="listingblock"> |
| 856 | <div class="content"> |
| 857 | <pre><tt>$ cat ~/test.sh |
| 858 | #!/bin/sh |
| 859 | |
| 860 | # tweak the working tree by merging the hot-fix branch |
| 861 | # and then attempt a build |
| 862 | if git merge --no-commit hot-fix && |
| 863 | make |
| 864 | then |
| 865 | # run project specific test and report its status |
| 866 | ~/check_test_case.sh |
| 867 | status=$? |
| 868 | else |
| 869 | # tell the caller this is untestable |
| 870 | status=125 |
| 871 | fi |
| 872 | |
| 873 | # undo the tweak to allow clean flipping to the next commit |
| 874 | git reset --hard |
| 875 | |
| 876 | # return control |
| 877 | exit $status</tt></pre> |
| 878 | </div></div> |
| 879 | <div class="paragraph"><p>This applies modifications from a hot-fix branch before each test run, |
| 880 | e.g. in case your build or test environment changed so that older |
| 881 | revisions may need a fix which newer ones have already. (Make sure the |
| 882 | hot-fix branch is based off a commit which is contained in all revisions |
| 883 | which you are bisecting, so that the merge does not pull in too much, or |
| 884 | use <tt>git cherry-pick</tt> instead of <tt>git merge</tt>.)</p></div> |
| 885 | </li> |
| 886 | <li> |
| 887 | <p> |
| 888 | Automatically bisect a broken test case: |
Junio C Hamano | 0a23522 | 2009-03-06 08:21:09 | [diff] [blame] | 889 | </p> |
| 890 | <div class="listingblock"> |
| 891 | <div class="content"> |
| 892 | <pre><tt>$ git bisect start HEAD HEAD~10 -- # culprit is among the last 10 |
| 893 | $ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"</tt></pre> |
| 894 | </div></div> |
Junio C Hamano | 9a2fb2d | 2011-03-23 05:40:15 | [diff] [blame] | 895 | <div class="paragraph"><p>This shows that you can do without a run script if you write the test |
| 896 | on a single line.</p></div> |
Junio C Hamano | 0a23522 | 2009-03-06 08:21:09 | [diff] [blame] | 897 | </li> |
Junio C Hamano | f727901 | 2011-08-18 06:13:13 | [diff] [blame] | 898 | <li> |
| 899 | <p> |
| 900 | Locate a good region of the object graph in a damaged repository |
| 901 | </p> |
| 902 | <div class="listingblock"> |
| 903 | <div class="content"> |
| 904 | <pre><tt>$ git bisect start HEAD <known-good-commit> [ <boundary-commit> ... ] --no-checkout |
| 905 | $ git bisect run sh -c ' |
| 906 | GOOD=$(git for-each-ref "--format=%(objectname)" refs/bisect/good-*) && |
| 907 | git rev-list --objects BISECT_HEAD --not $GOOD >tmp.$$ && |
| 908 | git pack-objects --stdout >/dev/null <tmp.$$ |
| 909 | rc=$? |
| 910 | rm -f tmp.$$ |
| 911 | test $rc = 0'</tt></pre> |
| 912 | </div></div> |
| 913 | <div class="paragraph"><p>In this case, when <em>git bisect run</em> finishes, bisect/bad will refer to a commit that |
| 914 | has at least one parent whose reachable graph is fully traversable in the sense |
| 915 | required by <em>git pack objects</em>.</p></div> |
| 916 | </li> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 917 | </ul></div> |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 918 | </div> |
Junio C Hamano | 2bd8a74 | 2009-12-01 21:16:59 | [diff] [blame] | 919 | <h2 id="_see_also">SEE ALSO</h2> |
| 920 | <div class="sectionbody"> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 921 | <div class="paragraph"><p><a href="git-bisect-lk2009.html">Fighting regressions with git bisect</a>, |
Junio C Hamano | 2bd8a74 | 2009-12-01 21:16:59 | [diff] [blame] | 922 | <a href="git-blame.html">git-blame(1)</a>.</p></div> |
| 923 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 924 | <h2 id="_git">GIT</h2> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 925 | <div class="sectionbody"> |
Junio C Hamano | 103b572 | 2011-01-31 05:03:45 | [diff] [blame] | 926 | <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 927 | </div> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 928 | </div> |
| 929 | <div id="footnotes"><hr /></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 930 | <div id="footer"> |
| 931 | <div id="footer-text"> |
Junio C Hamano | 02194af | 2011-11-17 20:33:59 | [diff] [blame] | 932 | Last updated 2011-11-15 13:45:02 PDT |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 933 | </div> |
| 934 | </div> |
| 935 | </body> |
| 936 | </html> |