1#!/bin/sh
2
3USAGE='[help|start|bad|good|new|old|terms|skip|next|reset|visualize|replay|log|run]'
4LONG_USAGE='git bisect help
5 print this long help message.
6git bisect start [--term-{old,good}=<term> --term-{new,bad}=<term>]
7 [--no-checkout] [<bad> [<good>...]] [--] [<pathspec>...]
8 reset bisect state and start bisection.
9git bisect (bad|new) [<rev>]
10 mark <rev> a known-bad revision/
11 a revision after change in a given property.
12git bisect (good|old) [<rev>...]
13 mark <rev>... known-good revisions/
14 revisions before change in a given property.
15git bisect terms [--term-good | --term-bad]
16 show the terms used for old and new commits (default: bad, good)
17git bisect skip [(<rev>|<range>)...]
18 mark <rev>... untestable revisions.
19git bisect next
20 find next bisection to test and check it out.
21git bisect reset [<commit>]
22 finish bisection search and go back to commit.
23git bisect visualize
24 show bisect status in gitk.
25git bisect replay <logfile>
26 replay bisection log.
27git bisect log
28 show bisect log.
29git bisect run <cmd>...
30 use <cmd>... to automatically bisect.
31
32Please use "git help bisect" to get the full man page.'
33
34OPTIONS_SPEC=
35. git-sh-setup
36
37_x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
38_x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40"
39TERM_BAD=bad
40TERM_GOOD=good
41
42bisect_head()
43{
44 if test -f "$GIT_DIR/BISECT_HEAD"
45 then
46 echo BISECT_HEAD
47 else
48 echo HEAD
49 fi
50}
51
52bisect_autostart() {
53 test -s "$GIT_DIR/BISECT_START" || {
54 gettextln "You need to start by \"git bisect start\"" >&2
55 if test -t 0
56 then
57 # TRANSLATORS: Make sure to include [Y] and [n] in your
58 # translation. The program will only accept English input
59 # at this point.
60 gettext "Do you want me to do it for you [Y/n]? " >&2
61 read yesno
62 case "$yesno" in
63 [Nn]*)
64 exit ;;
65 esac
66 bisect_start
67 else
68 exit 1
69 fi
70 }
71}
72
73bisect_start() {
74 #
75 # Check for one bad and then some good revisions.
76 #
77 has_double_dash=0
78 for arg; do
79 case "$arg" in --) has_double_dash=1; break ;; esac
80 done
81 orig_args=$(git rev-parse --sq-quote "$@")
82 bad_seen=0
83 eval=''
84 must_write_terms=0
85 revs=''
86 if test "z$(git rev-parse --is-bare-repository)" != zfalse
87 then
88 mode=--no-checkout
89 else
90 mode=''
91 fi
92 while [ $# -gt 0 ]; do
93 arg="$1"
94 case "$arg" in
95 --)
96 shift
97 break
98 ;;
99 --no-checkout)
100 mode=--no-checkout
101 shift ;;
102 --term-good|--term-old)
103 shift
104 must_write_terms=1
105 TERM_GOOD=$1
106 shift ;;
107 --term-good=*|--term-old=*)
108 must_write_terms=1
109 TERM_GOOD=${1#*=}
110 shift ;;
111 --term-bad|--term-new)
112 shift
113 must_write_terms=1
114 TERM_BAD=$1
115 shift ;;
116 --term-bad=*|--term-new=*)
117 must_write_terms=1
118 TERM_BAD=${1#*=}
119 shift ;;
120 --*)
121 die "$(eval_gettext "unrecognised option: '\$arg'")" ;;
122 *)
123 rev=$(git rev-parse -q --verify "$arg^{commit}") || {
124 test $has_double_dash -eq 1 &&
125 die "$(eval_gettext "'\$arg' does not appear to be a valid revision")"
126 break
127 }
128 revs="$revs $rev"
129 shift
130 ;;
131 esac
132 done
133
134 for rev in $revs
135 do
136 # The user ran "git bisect start <sha1>
137 # <sha1>", hence did not explicitly specify
138 # the terms, but we are already starting to
139 # set references named with the default terms,
140 # and won't be able to change afterwards.
141 must_write_terms=1
142
143 case $bad_seen in
144 0) state=$TERM_BAD ; bad_seen=1 ;;
145 *) state=$TERM_GOOD ;;
146 esac
147 eval="$eval bisect_write '$state' '$rev' 'nolog' &&"
148 done
149 #
150 # Verify HEAD.
151 #
152 head=$(GIT_DIR="$GIT_DIR" git symbolic-ref -q HEAD) ||
153 head=$(GIT_DIR="$GIT_DIR" git rev-parse --verify HEAD) ||
154 die "$(gettext "Bad HEAD - I need a HEAD")"
155
156 #
157 # Check if we are bisecting.
158 #
159 start_head=''
160 if test -s "$GIT_DIR/BISECT_START"
161 then
162 # Reset to the rev from where we started.
163 start_head=$(cat "$GIT_DIR/BISECT_START")
164 if test "z$mode" != "z--no-checkout"
165 then
166 git checkout "$start_head" -- ||
167 die "$(eval_gettext "Checking out '\$start_head' failed. Try 'git bisect reset <valid-branch>'.")"
168 fi
169 else
170 # Get rev from where we start.
171 case "$head" in
172 refs/heads/*|$_x40)
173 # This error message should only be triggered by
174 # cogito usage, and cogito users should understand
175 # it relates to cg-seek.
176 [ -s "$GIT_DIR/head-name" ] &&
177 die "$(gettext "won't bisect on cg-seek'ed tree")"
178 start_head="${head#refs/heads/}"
179 ;;
180 *)
181 die "$(gettext "Bad HEAD - strange symbolic ref")"
182 ;;
183 esac
184 fi
185
186 #
187 # Get rid of any old bisect state.
188 #
189 git bisect--helper --bisect-clean-state || exit
190
191 #
192 # Change state.
193 # In case of mistaken revs or checkout error, or signals received,
194 # "bisect_auto_next" below may exit or misbehave.
195 # We have to trap this to be able to clean up using
196 # "bisect_clean_state".
197 #
198 trap 'git bisect--helper --bisect-clean-state' 0
199 trap 'exit 255' 1 2 3 15
200
201 #
202 # Write new start state.
203 #
204 echo "$start_head" >"$GIT_DIR/BISECT_START" && {
205 test "z$mode" != "z--no-checkout" ||
206 git update-ref --no-deref BISECT_HEAD "$start_head"
207 } &&
208 git rev-parse --sq-quote "$@" >"$GIT_DIR/BISECT_NAMES" &&
209 eval "$eval true" &&
210 if test $must_write_terms -eq 1
211 then
212 git bisect--helper --write-terms "$TERM_BAD" "$TERM_GOOD" || exit
213 fi &&
214 echo "git bisect start$orig_args" >>"$GIT_DIR/BISECT_LOG" || exit
215 #
216 # Check if we can proceed to the next bisect state.
217 #
218 bisect_auto_next
219
220 trap '-' 0
221}
222
223bisect_write() {
224 state="$1"
225 rev="$2"
226 nolog="$3"
227 case "$state" in
228 "$TERM_BAD")
229 tag="$state" ;;
230 "$TERM_GOOD"|skip)
231 tag="$state"-"$rev" ;;
232 *)
233 die "$(eval_gettext "Bad bisect_write argument: \$state")" ;;
234 esac
235 git update-ref "refs/bisect/$tag" "$rev" || exit
236 echo "# $state: $(git show-branch $rev)" >>"$GIT_DIR/BISECT_LOG"
237 test -n "$nolog" || echo "git bisect $state $rev" >>"$GIT_DIR/BISECT_LOG"
238}
239
240is_expected_rev() {
241 test -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
242 test "$1" = $(cat "$GIT_DIR/BISECT_EXPECTED_REV")
243}
244
245check_expected_revs() {
246 for _rev in "$@"; do
247 if ! is_expected_rev "$_rev"
248 then
249 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK"
250 rm -f "$GIT_DIR/BISECT_EXPECTED_REV"
251 return
252 fi
253 done
254}
255
256bisect_skip() {
257 all=''
258 for arg in "$@"
259 do
260 case "$arg" in
261 *..*)
262 revs=$(git rev-list "$arg") || die "$(eval_gettext "Bad rev input: \$arg")" ;;
263 *)
264 revs=$(git rev-parse --sq-quote "$arg") ;;
265 esac
266 all="$all $revs"
267 done
268 eval bisect_state 'skip' $all
269}
270
271bisect_state() {
272 bisect_autostart
273 state=$1
274 check_and_set_terms $state
275 case "$#,$state" in
276 0,*)
277 die "Please call 'bisect_state' with at least one argument." ;;
278 1,"$TERM_BAD"|1,"$TERM_GOOD"|1,skip)
279 bisected_head=$(bisect_head)
280 rev=$(git rev-parse --verify "$bisected_head") ||
281 die "$(eval_gettext "Bad rev input: \$bisected_head")"
282 bisect_write "$state" "$rev"
283 check_expected_revs "$rev" ;;
284 2,"$TERM_BAD"|*,"$TERM_GOOD"|*,skip)
285 shift
286 hash_list=''
287 for rev in "$@"
288 do
289 sha=$(git rev-parse --verify "$rev^{commit}") ||
290 die "$(eval_gettext "Bad rev input: \$rev")"
291 hash_list="$hash_list $sha"
292 done
293 for rev in $hash_list
294 do
295 bisect_write "$state" "$rev"
296 done
297 check_expected_revs $hash_list ;;
298 *,"$TERM_BAD")
299 die "$(eval_gettext "'git bisect \$TERM_BAD' can take only one argument.")" ;;
300 *)
301 usage ;;
302 esac
303 bisect_auto_next
304}
305
306bisect_next_check() {
307 missing_good= missing_bad=
308 git show-ref -q --verify refs/bisect/$TERM_BAD || missing_bad=t
309 test -n "$(git for-each-ref "refs/bisect/$TERM_GOOD-*")" || missing_good=t
310
311 case "$missing_good,$missing_bad,$1" in
312 ,,*)
313 : have both $TERM_GOOD and $TERM_BAD - ok
314 ;;
315 *,)
316 # do not have both but not asked to fail - just report.
317 false
318 ;;
319 t,,"$TERM_GOOD")
320 # have bad (or new) but not good (or old). we could bisect although
321 # this is less optimum.
322 eval_gettextln "Warning: bisecting only with a \$TERM_BAD commit." >&2
323 if test -t 0
324 then
325 # TRANSLATORS: Make sure to include [Y] and [n] in your
326 # translation. The program will only accept English input
327 # at this point.
328 gettext "Are you sure [Y/n]? " >&2
329 read yesno
330 case "$yesno" in [Nn]*) exit 1 ;; esac
331 fi
332 : bisect without $TERM_GOOD...
333 ;;
334 *)
335 bad_syn=$(bisect_voc bad)
336 good_syn=$(bisect_voc good)
337 if test -s "$GIT_DIR/BISECT_START"
338 then
339
340 eval_gettextln "You need to give me at least one \$bad_syn and one \$good_syn revision.
341(You can use \"git bisect \$bad_syn\" and \"git bisect \$good_syn\" for that.)" >&2
342 else
343 eval_gettextln "You need to start by \"git bisect start\".
344You then need to give me at least one \$good_syn and one \$bad_syn revision.
345(You can use \"git bisect \$bad_syn\" and \"git bisect \$good_syn\" for that.)" >&2
346 fi
347 exit 1 ;;
348 esac
349}
350
351bisect_auto_next() {
352 bisect_next_check && bisect_next || :
353}
354
355bisect_next() {
356 case "$#" in 0) ;; *) usage ;; esac
357 bisect_autostart
358 bisect_next_check $TERM_GOOD
359
360 # Perform all bisection computation, display and checkout
361 git bisect--helper --next-all $(test -f "$GIT_DIR/BISECT_HEAD" && echo --no-checkout)
362 res=$?
363
364 # Check if we should exit because bisection is finished
365 if test $res -eq 10
366 then
367 bad_rev=$(git show-ref --hash --verify refs/bisect/$TERM_BAD)
368 bad_commit=$(git show-branch $bad_rev)
369 echo "# first $TERM_BAD commit: $bad_commit" >>"$GIT_DIR/BISECT_LOG"
370 exit 0
371 elif test $res -eq 2
372 then
373 echo "# only skipped commits left to test" >>"$GIT_DIR/BISECT_LOG"
374 good_revs=$(git for-each-ref --format="%(objectname)" "refs/bisect/$TERM_GOOD-*")
375 for skipped in $(git rev-list refs/bisect/$TERM_BAD --not $good_revs)
376 do
377 skipped_commit=$(git show-branch $skipped)
378 echo "# possible first $TERM_BAD commit: $skipped_commit" >>"$GIT_DIR/BISECT_LOG"
379 done
380 exit $res
381 fi
382
383 # Check for an error in the bisection process
384 test $res -ne 0 && exit $res
385
386 return 0
387}
388
389bisect_visualize() {
390 bisect_next_check fail
391
392 if test $# = 0
393 then
394 if test -n "${DISPLAY+set}${SESSIONNAME+set}${MSYSTEM+set}${SECURITYSESSIONID+set}" &&
395 type gitk >/dev/null 2>&1
396 then
397 set gitk
398 else
399 set git log
400 fi
401 else
402 case "$1" in
403 git*|tig) ;;
404 -*) set git log "$@" ;;
405 *) set git "$@" ;;
406 esac
407 fi
408
409 eval '"$@"' --bisect -- $(cat "$GIT_DIR/BISECT_NAMES")
410}
411
412bisect_reset() {
413 test -s "$GIT_DIR/BISECT_START" || {
414 gettextln "We are not bisecting."
415 return
416 }
417 case "$#" in
418 0) branch=$(cat "$GIT_DIR/BISECT_START") ;;
419 1) git rev-parse --quiet --verify "$1^{commit}" >/dev/null || {
420 invalid="$1"
421 die "$(eval_gettext "'\$invalid' is not a valid commit")"
422 }
423 branch="$1" ;;
424 *)
425 usage ;;
426 esac
427
428 if ! test -f "$GIT_DIR/BISECT_HEAD" && ! git checkout "$branch" --
429 then
430 die "$(eval_gettext "Could not check out original HEAD '\$branch'.
431Try 'git bisect reset <commit>'.")"
432 fi
433 git bisect--helper --bisect-clean-state || exit
434}
435
436bisect_replay () {
437 file="$1"
438 test "$#" -eq 1 || die "$(gettext "No logfile given")"
439 test -r "$file" || die "$(eval_gettext "cannot read \$file for replaying")"
440 bisect_reset
441 while read git bisect command rev
442 do
443 test "$git $bisect" = "git bisect" || test "$git" = "git-bisect" || continue
444 if test "$git" = "git-bisect"
445 then
446 rev="$command"
447 command="$bisect"
448 fi
449 get_terms
450 check_and_set_terms "$command"
451 case "$command" in
452 start)
453 cmd="bisect_start $rev"
454 eval "$cmd" ;;
455 "$TERM_GOOD"|"$TERM_BAD"|skip)
456 bisect_write "$command" "$rev" ;;
457 terms)
458 bisect_terms $rev ;;
459 *)
460 die "$(gettext "?? what are you talking about?")" ;;
461 esac
462 done <"$file"
463 bisect_auto_next
464}
465
466bisect_run () {
467 bisect_next_check fail
468
469 while true
470 do
471 command="$@"
472 eval_gettextln "running \$command"
473 "$@"
474 res=$?
475
476 # Check for really bad run error.
477 if [ $res -lt 0 -o $res -ge 128 ]
478 then
479 eval_gettextln "bisect run failed:
480exit code \$res from '\$command' is < 0 or >= 128" >&2
481 exit $res
482 fi
483
484 # Find current state depending on run success or failure.
485 # A special exit code of 125 means cannot test.
486 if [ $res -eq 125 ]
487 then
488 state='skip'
489 elif [ $res -gt 0 ]
490 then
491 state="$TERM_BAD"
492 else
493 state="$TERM_GOOD"
494 fi
495
496 # We have to use a subshell because "bisect_state" can exit.
497 ( bisect_state $state >"$GIT_DIR/BISECT_RUN" )
498 res=$?
499
500 cat "$GIT_DIR/BISECT_RUN"
501
502 if sane_grep "first $TERM_BAD commit could be any of" "$GIT_DIR/BISECT_RUN" \
503 >/dev/null
504 then
505 gettextln "bisect run cannot continue any more" >&2
506 exit $res
507 fi
508
509 if [ $res -ne 0 ]
510 then
511 eval_gettextln "bisect run failed:
512'bisect_state \$state' exited with error code \$res" >&2
513 exit $res
514 fi
515
516 if sane_grep "is the first $TERM_BAD commit" "$GIT_DIR/BISECT_RUN" >/dev/null
517 then
518 gettextln "bisect run success"
519 exit 0;
520 fi
521
522 done
523}
524
525bisect_log () {
526 test -s "$GIT_DIR/BISECT_LOG" || die "$(gettext "We are not bisecting.")"
527 cat "$GIT_DIR/BISECT_LOG"
528}
529
530get_terms () {
531 if test -s "$GIT_DIR/BISECT_TERMS"
532 then
533 {
534 read TERM_BAD
535 read TERM_GOOD
536 } <"$GIT_DIR/BISECT_TERMS"
537 fi
538}
539
540check_and_set_terms () {
541 cmd="$1"
542 case "$cmd" in
543 skip|start|terms) ;;
544 *)
545 if test -s "$GIT_DIR/BISECT_TERMS" && test "$cmd" != "$TERM_BAD" && test "$cmd" != "$TERM_GOOD"
546 then
547 die "$(eval_gettext "Invalid command: you're currently in a \$TERM_BAD/\$TERM_GOOD bisect.")"
548 fi
549 case "$cmd" in
550 bad|good)
551 if ! test -s "$GIT_DIR/BISECT_TERMS"
552 then
553 TERM_BAD=bad
554 TERM_GOOD=good
555 git bisect--helper --write-terms "$TERM_BAD" "$TERM_GOOD" || exit
556 fi
557 ;;
558 new|old)
559 if ! test -s "$GIT_DIR/BISECT_TERMS"
560 then
561 TERM_BAD=new
562 TERM_GOOD=old
563 git bisect--helper --write-terms "$TERM_BAD" "$TERM_GOOD" || exit
564 fi
565 ;;
566 esac ;;
567 esac
568}
569
570bisect_voc () {
571 case "$1" in
572 bad) echo "bad|new" ;;
573 good) echo "good|old" ;;
574 esac
575}
576
577bisect_terms () {
578 get_terms
579 if ! test -s "$GIT_DIR/BISECT_TERMS"
580 then
581 die "$(gettext "no terms defined")"
582 fi
583 case "$#" in
584 0)
585 gettextln "Your current terms are $TERM_GOOD for the old state
586and $TERM_BAD for the new state."
587 ;;
588 1)
589 arg=$1
590 case "$arg" in
591 --term-good|--term-old)
592 printf '%s\n' "$TERM_GOOD"
593 ;;
594 --term-bad|--term-new)
595 printf '%s\n' "$TERM_BAD"
596 ;;
597 *)
598 die "$(eval_gettext "invalid argument \$arg for 'git bisect terms'.
599Supported options are: --term-good|--term-old and --term-bad|--term-new.")"
600 ;;
601 esac
602 ;;
603 *)
604 usage ;;
605 esac
606}
607
608case "$#" in
6090)
610 usage ;;
611*)
612 cmd="$1"
613 get_terms
614 shift
615 case "$cmd" in
616 help)
617 git bisect -h ;;
618 start)
619 bisect_start "$@" ;;
620 bad|good|new|old|"$TERM_BAD"|"$TERM_GOOD")
621 bisect_state "$cmd" "$@" ;;
622 skip)
623 bisect_skip "$@" ;;
624 next)
625 # Not sure we want "next" at the UI level anymore.
626 bisect_next "$@" ;;
627 visualize|view)
628 bisect_visualize "$@" ;;
629 reset)
630 bisect_reset "$@" ;;
631 replay)
632 bisect_replay "$@" ;;
633 log)
634 bisect_log ;;
635 run)
636 bisect_run "$@" ;;
637 terms)
638 bisect_terms "$@" ;;
639 *)
640 usage ;;
641 esac
642esac