1#!/bin/sh 2 3USAGE='[help|start|bad|good|skip|next|reset|visualize|replay|log|run]' 4LONG_USAGE='git bisect help 5 print this long help message. 6git bisect start [<bad> [<good>...]] [--] [<pathspec>...] 7 reset bisect state and start bisection. 8git bisect bad [<rev>] 9 mark <rev> a known-bad revision. 10git bisect good [<rev>...] 11 mark <rev>... known-good revisions. 12git bisect skip [(<rev>|<range>)...] 13 mark <rev>... untestable revisions. 14git bisect next 15 find next bisection to test and check it out. 16git bisect reset [<branch>] 17 finish bisection search and go back to branch. 18git bisect visualize 19 show bisect status in gitk. 20git bisect replay <logfile> 21 replay bisection log. 22git bisect log 23 show bisect log. 24git bisect run <cmd>... 25 use <cmd>... to automatically bisect. 26 27Please use "git help bisect" to get the full man page.' 28 29OPTIONS_SPEC= 30. git-sh-setup 31require_work_tree 32 33_x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]' 34_x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40" 35 36sq() { 37 @@PERL@@ -e' 38 for (@ARGV) { 39 s/'\''/'\'\\\\\'\''/g; 40 print " '\''$_'\''"; 41 } 42 print "\n"; 43 '"$@" 44} 45 46bisect_autostart() { 47test -s"$GIT_DIR/BISECT_START"|| { 48echo>&2'You need to start by "git bisect start"' 49iftest -t0 50then 51echo>&2-n'Do you want me to do it for you [Y/n]? ' 52read yesno 53case"$yesno"in 54[Nn]*) 55exit;; 56esac 57 bisect_start 58else 59exit1 60fi 61} 62} 63 64bisect_start() { 65# 66# Verify HEAD. 67# 68head=$(GIT_DIR="$GIT_DIR" git symbolic-ref -q HEAD)|| 69head=$(GIT_DIR="$GIT_DIR" git rev-parse --verify HEAD)|| 70 die "Bad HEAD - I need a HEAD" 71 72# 73# Check if we are bisecting. 74# 75 start_head='' 76iftest -s"$GIT_DIR/BISECT_START" 77then 78# Reset to the rev from where we started. 79 start_head=$(cat "$GIT_DIR/BISECT_START") 80 git checkout "$start_head"||exit 81else 82# Get rev from where we start. 83case"$head"in 84 refs/heads/*|$_x40) 85# This error message should only be triggered by 86# cogito usage, and cogito users should understand 87# it relates to cg-seek. 88[-s"$GIT_DIR/head-name"] && 89 die "won't bisect on seeked tree" 90 start_head="${head#refs/heads/}" 91;; 92*) 93 die "Bad HEAD - strange symbolic ref" 94;; 95esac 96fi 97 98# 99# Get rid of any old bisect state. 100# 101 bisect_clean_state ||exit 102 103# 104# Check for one bad and then some good revisions. 105# 106 has_double_dash=0 107for arg;do 108case"$arg"in--) has_double_dash=1;break;;esac 109done 110 orig_args=$(sq "$@") 111 bad_seen=0 112eval='' 113while[$#-gt0];do 114 arg="$1" 115case"$arg"in 116--) 117shift 118break 119;; 120*) 121rev=$(git rev-parse -q --verify "$arg^{commit}")|| { 122test$has_double_dash-eq1&& 123 die "'$arg' does not appear to be a valid revision" 124break 125} 126case$bad_seenin 1270) state='bad'; bad_seen=1;; 128*) state='good';; 129esac 130eval="$evalbisect_write '$state' '$rev' 'nolog'; " 131shift 132;; 133esac 134done 135 136# 137# Change state. 138# In case of mistaken revs or checkout error, or signals received, 139# "bisect_auto_next" below may exit or misbehave. 140# We have to trap this to be able to clean up using 141# "bisect_clean_state". 142# 143trap'bisect_clean_state'0 144trap'exit 255'1 2 3 15 145 146# 147# Write new start state. 148# 149echo"$start_head">"$GIT_DIR/BISECT_START"&& 150sq"$@">"$GIT_DIR/BISECT_NAMES"&& 151eval"$eval"&& 152echo"git bisect start$orig_args">>"$GIT_DIR/BISECT_LOG"||exit 153# 154# Check if we can proceed to the next bisect state. 155# 156 bisect_auto_next 157 158trap'-'0 159} 160 161bisect_write() { 162 state="$1" 163rev="$2" 164 nolog="$3" 165case"$state"in 166 bad) tag="$state";; 167 good|skip) tag="$state"-"$rev";; 168*) die "Bad bisect_write argument:$state";; 169esac 170 git update-ref"refs/bisect/$tag""$rev"||exit 171echo"#$state:$(git show-branch $rev)">>"$GIT_DIR/BISECT_LOG" 172test -n"$nolog"||echo"git bisect$state$rev">>"$GIT_DIR/BISECT_LOG" 173} 174 175is_expected_rev() { 176test -f"$GIT_DIR/BISECT_EXPECTED_REV"&& 177test"$1"=$(cat "$GIT_DIR/BISECT_EXPECTED_REV") 178} 179 180mark_expected_rev() { 181echo"$1">"$GIT_DIR/BISECT_EXPECTED_REV" 182} 183 184check_expected_revs() { 185for _rev in"$@";do 186if! is_expected_rev "$_rev";then 187rm-f"$GIT_DIR/BISECT_ANCESTORS_OK" 188rm-f"$GIT_DIR/BISECT_EXPECTED_REV" 189return 190fi 191done 192} 193 194bisect_skip() { 195 all='' 196for arg in"$@" 197do 198case"$arg"in 199*..*) 200 revs=$(git rev-list "$arg")|| die "Bad rev input:$arg";; 201*) 202 revs=$(sq "$arg");; 203esac 204 all="$all$revs" 205done 206eval bisect_state 'skip'$all 207} 208 209bisect_state() { 210 bisect_autostart 211 state=$1 212case"$#,$state"in 2130,*) 214 die "Please call 'bisect_state' with at least one argument.";; 2151,bad|1,good|1,skip) 216rev=$(git rev-parse --verify HEAD)|| 217 die "Bad rev input: HEAD" 218 bisect_write "$state""$rev" 219 check_expected_revs "$rev";; 2202,bad|*,good|*,skip) 221shift 222eval='' 223forrevin"$@" 224do 225 sha=$(git rev-parse --verify "$rev^{commit}")|| 226 die "Bad rev input:$rev" 227eval="$evalbisect_write '$state' '$sha'; " 228done 229eval"$eval" 230 check_expected_revs "$@";; 231*,bad) 232 die "'git bisect bad' can take only one argument.";; 233*) 234 usage ;; 235esac 236 bisect_auto_next 237} 238 239bisect_next_check() { 240 missing_good= missing_bad= 241 git show-ref -q --verify refs/bisect/bad || missing_bad=t 242test -n"$(git for-each-ref "refs/bisect/good-*")"|| missing_good=t 243 244case"$missing_good,$missing_bad,$1"in 245,,*) 246: have both good and bad - ok 247;; 248*,) 249# do not have both but not asked to fail - just report. 250 false 251;; 252 t,,good) 253# have bad but not good. we could bisect although 254# this is less optimum. 255echo>&2'Warning: bisecting only with a bad commit.' 256iftest -t0 257then 258printf>&2'Are you sure [Y/n]? ' 259read yesno 260case"$yesno"in[Nn]*)exit1;;esac 261fi 262: bisect without good... 263;; 264*) 265 THEN='' 266test -s"$GIT_DIR/BISECT_START"|| { 267echo>&2'You need to start by "git bisect start".' 268 THEN='then ' 269} 270echo>&2'You '$THEN'need to give me at least one good' \ 271'and one bad revisions.' 272echo>&2'(You can use "git bisect bad" and' \ 273'"git bisect good" for that.)' 274exit1;; 275esac 276} 277 278bisect_auto_next() { 279 bisect_next_check && bisect_next || : 280} 281 282eval_and_string_together() { 283 _eval="$1" 284 285eval"$_eval"| { 286whileread line 287do 288echo"$line&&" 289done 290echo':' 291} 292} 293 294exit_if_skipped_commits () { 295 _tried=$1 296 _bad=$2 297iftest -n"$_tried";then 298echo"There are only 'skip'ped commit left to test." 299echo"The first bad commit could be any of:" 300echo"$_tried"|tr'[|]''[\012]' 301test -n"$_bad"&&echo"$_bad" 302echo"We cannot bisect more!" 303exit2 304fi 305} 306 307bisect_checkout() { 308 _rev="$1" 309 _msg="$2" 310echo"Bisecting:$_msg" 311 mark_expected_rev "$_rev" 312 git checkout -q"$_rev"||exit 313 git show-branch"$_rev" 314} 315 316is_among() { 317 _rev="$1" 318 _list="$2" 319case"$_list"in*$_rev*)return0;;esac 320return1 321} 322 323handle_bad_merge_base() { 324 _badmb="$1" 325 _good="$2" 326if is_expected_rev "$_badmb";then 327cat>&2<<EOF 328The merge base$_badmbis bad. 329This means the bug has been fixed between$_badmband [$_good]. 330EOF 331exit3 332else 333cat>&2<<EOF 334Some good revs are not ancestor of the bad rev. 335git bisect cannot work properly in this case. 336Maybe you mistake good and bad revs? 337EOF 338exit1 339fi 340} 341 342handle_skipped_merge_base() { 343 _mb="$1" 344 _bad="$2" 345 _good="$3" 346cat>&2<<EOF 347Warning: the merge base between$_badand [$_good] must be skipped. 348So we cannot be sure the first bad commit is between$_mband$_bad. 349We continue anyway. 350EOF 351} 352 353# 354# "check_merge_bases" checks that merge bases are not "bad". 355# 356# - If one is "good", that's good, we have nothing to do. 357# - If one is "bad", it means the user assumed something wrong 358# and we must exit. 359# - If one is "skipped", we can't know but we should warn. 360# - If we don't know, we should check it out and ask the user to test. 361# 362# In the last case we will return 1, and otherwise 0. 363# 364check_merge_bases() { 365 _bad="$1" 366 _good="$2" 367 _skip="$3" 368for _mb in$(git merge-base --all $_bad $_good) 369do 370if is_among "$_mb""$_good";then 371continue 372eliftest"$_mb"="$_bad";then 373 handle_bad_merge_base "$_bad""$_good" 374elif is_among "$_mb""$_skip";then 375 handle_skipped_merge_base "$_mb""$_bad""$_good" 376else 377 bisect_checkout "$_mb""a merge base must be tested" 378return1 379fi 380done 381return0 382} 383 384# 385# "check_good_are_ancestors_of_bad" checks that all "good" revs are 386# ancestor of the "bad" rev. 387# 388# If that's not the case, we need to check the merge bases. 389# If a merge base must be tested by the user we return 1 and 390# otherwise 0. 391# 392check_good_are_ancestors_of_bad() { 393test -f"$GIT_DIR/BISECT_ANCESTORS_OK"&& 394return 395 396 _bad="$1" 397 _good=$(echo $2 | sed -e 's/\^//g') 398 _skip="$3" 399 400# Bisecting with no good rev is ok 401test -z"$_good"&&return 402 403 _side=$(git rev-list $_good ^$_bad) 404iftest -n"$_side";then 405# Return if a checkout was done 406 check_merge_bases "$_bad""$_good""$_skip"||return 407fi 408 409: >"$GIT_DIR/BISECT_ANCESTORS_OK" 410 411return0 412} 413 414bisect_next() { 415case"$#"in0) ;; *) usage ;;esac 416 bisect_autostart 417 bisect_next_check good 418 419# Get bad, good and skipped revs 420 bad=$(git rev-parse --verify refs/bisect/bad)&& 421 good=$(git for-each-ref --format='^%(objectname)' \ 422 "refs/bisect/good-*" | tr '\012' '') && 423 skip=$(git for-each-ref --format='%(objectname)' \ 424"refs/bisect/skip-*"|tr'\012'' ') ||exit 425 426# Maybe some merge bases must be tested first 427 check_good_are_ancestors_of_bad "$bad""$good""$skip" 428# Return now if a checkout has already been done 429test"$?"-eq"1"&&return 430 431# Get bisection information 432eval="git bisect--helper --next-vars"&& 433eval=$(eval_and_string_together "$eval")&& 434eval"$eval"||exit 435 436if[-z"$bisect_rev"];then 437# We should exit here only if the "bad" 438# commit is also a "skip" commit (see above). 439 exit_if_skipped_commits "$bisect_tried" 440echo"$badwas both good and bad" 441exit1 442fi 443if["$bisect_rev"="$bad"];then 444 exit_if_skipped_commits "$bisect_tried""$bad" 445echo"$bisect_revis first bad commit" 446 git diff-tree --pretty$bisect_rev 447exit0 448fi 449 450 bisect_checkout "$bisect_rev""$bisect_nrrevisions left to test after this (roughly$bisect_stepssteps)" 451} 452 453bisect_visualize() { 454 bisect_next_check fail 455 456iftest$#=0 457then 458case"${DISPLAY+set}${SESSIONNAME+set}${MSYSTEM+set}${SECURITYSESSIONID+set}"in 459'')set git log ;; 460set*)set gitk ;; 461esac 462else 463case"$1"in 464 git*|tig) ;; 465-*)set git log "$@";; 466*)set git "$@";; 467esac 468fi 469 470 not=$(git for-each-ref --format='%(refname)' "refs/bisect/good-*") 471 eval '"$@"' refs/bisect/bad --not$not--$(cat "$GIT_DIR/BISECT_NAMES") 472} 473 474bisect_reset() { 475 test -s "$GIT_DIR/BISECT_START" || { 476 echo "We are not bisecting." 477 return 478 } 479 case "$#" in 480 0) branch=$(cat "$GIT_DIR/BISECT_START");; 481 1) git show-ref --verify --quiet -- "refs/heads/$1" || 482 die "$1does not seem to be a valid branch" 483 branch="$1" ;; 484 *) 485 usage ;; 486 esac 487 git checkout "$branch" && bisect_clean_state 488} 489 490bisect_clean_state() { 491 # There may be some refs packed during bisection. 492 git for-each-ref --format='%(refname) %(objectname)' refs/bisect/\* | 493 while read ref hash 494 do 495 git update-ref -d$ref$hash|| exit 496 done 497 rm -f "$GIT_DIR/BISECT_EXPECTED_REV" && 498 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK" && 499 rm -f "$GIT_DIR/BISECT_LOG" && 500 rm -f "$GIT_DIR/BISECT_NAMES" && 501 rm -f "$GIT_DIR/BISECT_RUN" && 502 # Cleanup head-name if it got left by an old version of git-bisect 503 rm -f "$GIT_DIR/head-name" && 504 505 rm -f "$GIT_DIR/BISECT_START" 506} 507 508bisect_replay () { 509 test -r "$1" || die "cannot read$1for replaying" 510 bisect_reset 511 while read git bisect command rev 512 do 513 test "$git$bisect" = "git bisect" -o "$git" = "git-bisect" || continue 514 if test "$git" = "git-bisect"; then 515 rev="$command" 516 command="$bisect" 517 fi 518 case "$command" in 519 start) 520 cmd="bisect_start$rev" 521 eval "$cmd" ;; 522 good|bad|skip) 523 bisect_write "$command" "$rev" ;; 524 *) 525 die "?? what are you talking about?" ;; 526 esac 527 done <"$1" 528 bisect_auto_next 529} 530 531bisect_run () { 532 bisect_next_check fail 533 534 while true 535 do 536 echo "running $@" 537 "$@" 538 res=$? 539 540 # Check for really bad run error. 541 if [$res-lt 0 -o$res-ge 128 ]; then 542 echo >&2 "bisect run failed:" 543 echo >&2 "exit code$resfrom '$@' is < 0 or >= 128" 544 exit$res 545 fi 546 547 # Find current state depending on run success or failure. 548 # A special exit code of 125 means cannot test. 549 if [$res-eq 125 ]; then 550 state='skip' 551 elif [$res-gt 0 ]; then 552 state='bad' 553 else 554 state='good' 555 fi 556 557 # We have to use a subshell because "bisect_state" can exit. 558 ( bisect_state$state> "$GIT_DIR/BISECT_RUN" ) 559 res=$? 560 561 cat "$GIT_DIR/BISECT_RUN" 562 563 if grep "first bad commit could be any of" "$GIT_DIR/BISECT_RUN" \ 564 > /dev/null; then 565 echo >&2 "bisect run cannot continue any more" 566 exit$res 567 fi 568 569 if [$res-ne 0 ]; then 570 echo >&2 "bisect run failed:" 571 echo >&2 "'bisect_state $state' exited with error code$res" 572 exit$res 573 fi 574 575 if grep "is first bad commit" "$GIT_DIR/BISECT_RUN" > /dev/null; then 576 echo "bisect run success" 577 exit 0; 578 fi 579 580 done 581} 582 583 584case "$#" in 5850) 586 usage ;; 587*) 588 cmd="$1" 589 shift 590 case "$cmd" in 591 help) 592 git bisect -h ;; 593 start) 594 bisect_start "$@" ;; 595 bad|good) 596 bisect_state "$cmd" "$@" ;; 597 skip) 598 bisect_skip "$@" ;; 599 next) 600 # Not sure we want "next" at the UI level anymore. 601 bisect_next "$@" ;; 602 visualize|view) 603 bisect_visualize "$@" ;; 604 reset) 605 bisect_reset "$@" ;; 606 replay) 607 bisect_replay "$@" ;; 608 log) 609 cat "$GIT_DIR/BISECT_LOG" ;; 610 run) 611 bisect_run "$@" ;; 612 *) 613 usage ;; 614 esac 615esac