parse-options: deduplicate parse_options_usage() calls
[git/debian.git] / git-bisect.sh
blob5d1cb00d86b3700b2012cae1ed3b3b8b744acaf2
1 #!/bin/sh
3 USAGE='[help|start|bad|good|new|old|terms|skip|next|reset|visualize|replay|log|run]'
4 LONG_USAGE='git bisect help
5 print this long help message.
6 git bisect start [--term-{old,good}=<term> --term-{new,bad}=<term>]
7 [--no-checkout] [<bad> [<good>...]] [--] [<pathspec>...]
8 reset bisect state and start bisection.
9 git bisect (bad|new) [<rev>]
10 mark <rev> a known-bad revision/
11 a revision after change in a given property.
12 git bisect (good|old) [<rev>...]
13 mark <rev>... known-good revisions/
14 revisions before change in a given property.
15 git bisect terms [--term-good | --term-bad]
16 show the terms used for old and new commits (default: bad, good)
17 git bisect skip [(<rev>|<range>)...]
18 mark <rev>... untestable revisions.
19 git bisect next
20 find next bisection to test and check it out.
21 git bisect reset [<commit>]
22 finish bisection search and go back to commit.
23 git bisect visualize
24 show bisect status in gitk.
25 git bisect replay <logfile>
26 replay bisection log.
27 git bisect log
28 show bisect log.
29 git bisect run <cmd>...
30 use <cmd>... to automatically bisect.
32 Please use "git help bisect" to get the full man page.'
34 OPTIONS_SPEC=
35 . git-sh-setup
36 . git-sh-i18n
38 _x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
39 _x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40"
40 TERM_BAD=bad
41 TERM_GOOD=good
43 bisect_head()
45 if test -f "$GIT_DIR/BISECT_HEAD"
46 then
47 echo BISECT_HEAD
48 else
49 echo HEAD
53 bisect_autostart() {
54 test -s "$GIT_DIR/BISECT_START" || {
55 gettextln "You need to start by \"git bisect start\"" >&2
56 if test -t 0
57 then
58 # TRANSLATORS: Make sure to include [Y] and [n] in your
59 # translation. The program will only accept English input
60 # at this point.
61 gettext "Do you want me to do it for you [Y/n]? " >&2
62 read yesno
63 case "$yesno" in
64 [Nn]*)
65 exit ;;
66 esac
67 bisect_start
68 else
69 exit 1
74 bisect_start() {
76 # Check for one bad and then some good revisions.
78 has_double_dash=0
79 for arg; do
80 case "$arg" in --) has_double_dash=1; break ;; esac
81 done
82 orig_args=$(git rev-parse --sq-quote "$@")
83 bad_seen=0
84 eval=''
85 must_write_terms=0
86 revs=''
87 if test "z$(git rev-parse --is-bare-repository)" != zfalse
88 then
89 mode=--no-checkout
90 else
91 mode=''
93 while [ $# -gt 0 ]; do
94 arg="$1"
95 case "$arg" in
96 --)
97 shift
98 break
100 --no-checkout)
101 mode=--no-checkout
102 shift ;;
103 --term-good|--term-old)
104 shift
105 must_write_terms=1
106 TERM_GOOD=$1
107 shift ;;
108 --term-good=*|--term-old=*)
109 must_write_terms=1
110 TERM_GOOD=${1#*=}
111 shift ;;
112 --term-bad|--term-new)
113 shift
114 must_write_terms=1
115 TERM_BAD=$1
116 shift ;;
117 --term-bad=*|--term-new=*)
118 must_write_terms=1
119 TERM_BAD=${1#*=}
120 shift ;;
121 --*)
122 die "$(eval_gettext "unrecognised option: '\$arg'")" ;;
124 rev=$(git rev-parse -q --verify "$arg^{commit}") || {
125 test $has_double_dash -eq 1 &&
126 die "$(eval_gettext "'\$arg' does not appear to be a valid revision")"
127 break
129 revs="$revs $rev"
130 shift
132 esac
133 done
135 for rev in $revs
137 # The user ran "git bisect start <sha1>
138 # <sha1>", hence did not explicitly specify
139 # the terms, but we are already starting to
140 # set references named with the default terms,
141 # and won't be able to change afterwards.
142 must_write_terms=1
144 case $bad_seen in
145 0) state=$TERM_BAD ; bad_seen=1 ;;
146 *) state=$TERM_GOOD ;;
147 esac
148 eval="$eval bisect_write '$state' '$rev' 'nolog' &&"
149 done
151 # Verify HEAD.
153 head=$(GIT_DIR="$GIT_DIR" git symbolic-ref -q HEAD) ||
154 head=$(GIT_DIR="$GIT_DIR" git rev-parse --verify HEAD) ||
155 die "$(gettext "Bad HEAD - I need a HEAD")"
158 # Check if we are bisecting.
160 start_head=''
161 if test -s "$GIT_DIR/BISECT_START"
162 then
163 # Reset to the rev from where we started.
164 start_head=$(cat "$GIT_DIR/BISECT_START")
165 if test "z$mode" != "z--no-checkout"
166 then
167 git checkout "$start_head" -- ||
168 die "$(eval_gettext "Checking out '\$start_head' failed. Try 'git bisect reset <valid-branch>'.")"
170 else
171 # Get rev from where we start.
172 case "$head" in
173 refs/heads/*|$_x40)
174 # This error message should only be triggered by
175 # cogito usage, and cogito users should understand
176 # it relates to cg-seek.
177 [ -s "$GIT_DIR/head-name" ] &&
178 die "$(gettext "won't bisect on cg-seek'ed tree")"
179 start_head="${head#refs/heads/}"
182 die "$(gettext "Bad HEAD - strange symbolic ref")"
184 esac
188 # Get rid of any old bisect state.
190 bisect_clean_state || exit
193 # Change state.
194 # In case of mistaken revs or checkout error, or signals received,
195 # "bisect_auto_next" below may exit or misbehave.
196 # We have to trap this to be able to clean up using
197 # "bisect_clean_state".
199 trap 'bisect_clean_state' 0
200 trap 'exit 255' 1 2 3 15
203 # Write new start state.
205 echo "$start_head" >"$GIT_DIR/BISECT_START" && {
206 test "z$mode" != "z--no-checkout" ||
207 git update-ref --no-deref BISECT_HEAD "$start_head"
208 } &&
209 git rev-parse --sq-quote "$@" >"$GIT_DIR/BISECT_NAMES" &&
210 eval "$eval true" &&
211 if test $must_write_terms -eq 1
212 then
213 write_terms "$TERM_BAD" "$TERM_GOOD"
214 fi &&
215 echo "git bisect start$orig_args" >>"$GIT_DIR/BISECT_LOG" || exit
217 # Check if we can proceed to the next bisect state.
219 bisect_auto_next
221 trap '-' 0
224 bisect_write() {
225 state="$1"
226 rev="$2"
227 nolog="$3"
228 case "$state" in
229 "$TERM_BAD")
230 tag="$state" ;;
231 "$TERM_GOOD"|skip)
232 tag="$state"-"$rev" ;;
234 die "$(eval_gettext "Bad bisect_write argument: \$state")" ;;
235 esac
236 git update-ref "refs/bisect/$tag" "$rev" || exit
237 echo "# $state: $(git show-branch $rev)" >>"$GIT_DIR/BISECT_LOG"
238 test -n "$nolog" || echo "git bisect $state $rev" >>"$GIT_DIR/BISECT_LOG"
241 is_expected_rev() {
242 test -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
243 test "$1" = $(cat "$GIT_DIR/BISECT_EXPECTED_REV")
246 check_expected_revs() {
247 for _rev in "$@"; do
248 if ! is_expected_rev "$_rev"
249 then
250 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK"
251 rm -f "$GIT_DIR/BISECT_EXPECTED_REV"
252 return
254 done
257 bisect_skip() {
258 all=''
259 for arg in "$@"
261 case "$arg" in
262 *..*)
263 revs=$(git rev-list "$arg") || die "$(eval_gettext "Bad rev input: \$arg")" ;;
265 revs=$(git rev-parse --sq-quote "$arg") ;;
266 esac
267 all="$all $revs"
268 done
269 eval bisect_state 'skip' $all
272 bisect_state() {
273 bisect_autostart
274 state=$1
275 check_and_set_terms $state
276 case "$#,$state" in
277 0,*)
278 die "$(gettext "Please call 'bisect_state' with at least one argument.")" ;;
279 1,"$TERM_BAD"|1,"$TERM_GOOD"|1,skip)
280 rev=$(git rev-parse --verify $(bisect_head)) ||
281 die "$(gettext "Bad rev input: $(bisect_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 "$@"
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
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.")" ;;
301 usage ;;
302 esac
303 bisect_auto_next
306 bisect_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
311 case "$missing_good,$missing_bad,$1" in
312 ,,*)
313 : have both $TERM_GOOD and $TERM_BAD - ok
316 # do not have both but not asked to fail - just report.
317 false
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
332 : bisect without $TERM_GOOD...
335 bad_syn=$(bisect_voc bad)
336 good_syn=$(bisect_voc good)
337 if test -s "$GIT_DIR/BISECT_START"
338 then
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\".
344 You 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
347 exit 1 ;;
348 esac
351 bisect_auto_next() {
352 bisect_next_check && bisect_next || :
355 bisect_next() {
356 case "$#" in 0) ;; *) usage ;; esac
357 bisect_autostart
358 bisect_next_check $TERM_GOOD
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=$?
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)
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
383 # Check for an error in the bisection process
384 test $res -ne 0 && exit $res
386 return 0
389 bisect_visualize() {
390 bisect_next_check fail
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
401 else
402 case "$1" in
403 git*|tig) ;;
404 -*) set git log "$@" ;;
405 *) set git "$@" ;;
406 esac
409 eval '"$@"' --bisect -- $(cat "$GIT_DIR/BISECT_NAMES")
412 bisect_reset() {
413 test -s "$GIT_DIR/BISECT_START" || {
414 gettextln "We are not bisecting."
415 return
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")"
423 branch="$1" ;;
425 usage ;;
426 esac
428 if ! test -f "$GIT_DIR/BISECT_HEAD" && ! git checkout "$branch" --
429 then
430 die "$(eval_gettext "Could not check out original HEAD '\$branch'.
431 Try 'git bisect reset <commit>'.")"
433 bisect_clean_state
436 bisect_clean_state() {
437 # There may be some refs packed during bisection.
438 git for-each-ref --format='%(refname) %(objectname)' refs/bisect/\* |
439 while read ref hash
441 git update-ref -d $ref $hash || exit
442 done
443 rm -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
444 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK" &&
445 rm -f "$GIT_DIR/BISECT_LOG" &&
446 rm -f "$GIT_DIR/BISECT_NAMES" &&
447 rm -f "$GIT_DIR/BISECT_RUN" &&
448 rm -f "$GIT_DIR/BISECT_TERMS" &&
449 # Cleanup head-name if it got left by an old version of git-bisect
450 rm -f "$GIT_DIR/head-name" &&
451 git update-ref -d --no-deref BISECT_HEAD &&
452 # clean up BISECT_START last
453 rm -f "$GIT_DIR/BISECT_START"
456 bisect_replay () {
457 file="$1"
458 test "$#" -eq 1 || die "$(gettext "No logfile given")"
459 test -r "$file" || die "$(eval_gettext "cannot read \$file for replaying")"
460 bisect_reset
461 while read git bisect command rev
463 test "$git $bisect" = "git bisect" || test "$git" = "git-bisect" || continue
464 if test "$git" = "git-bisect"
465 then
466 rev="$command"
467 command="$bisect"
469 get_terms
470 check_and_set_terms "$command"
471 case "$command" in
472 start)
473 cmd="bisect_start $rev"
474 eval "$cmd" ;;
475 "$TERM_GOOD"|"$TERM_BAD"|skip)
476 bisect_write "$command" "$rev" ;;
477 terms)
478 bisect_terms $rev ;;
480 die "$(gettext "?? what are you talking about?")" ;;
481 esac
482 done <"$file"
483 bisect_auto_next
486 bisect_run () {
487 bisect_next_check fail
489 while true
491 command="$@"
492 eval_gettextln "running \$command"
493 "$@"
494 res=$?
496 # Check for really bad run error.
497 if [ $res -lt 0 -o $res -ge 128 ]
498 then
499 eval_gettextln "bisect run failed:
500 exit code \$res from '\$command' is < 0 or >= 128" >&2
501 exit $res
504 # Find current state depending on run success or failure.
505 # A special exit code of 125 means cannot test.
506 if [ $res -eq 125 ]
507 then
508 state='skip'
509 elif [ $res -gt 0 ]
510 then
511 state="$TERM_BAD"
512 else
513 state="$TERM_GOOD"
516 # We have to use a subshell because "bisect_state" can exit.
517 ( bisect_state $state >"$GIT_DIR/BISECT_RUN" )
518 res=$?
520 cat "$GIT_DIR/BISECT_RUN"
522 if sane_grep "first $TERM_BAD commit could be any of" "$GIT_DIR/BISECT_RUN" \
523 >/dev/null
524 then
525 gettextln "bisect run cannot continue any more" >&2
526 exit $res
529 if [ $res -ne 0 ]
530 then
531 eval_gettextln "bisect run failed:
532 'bisect_state \$state' exited with error code \$res" >&2
533 exit $res
536 if sane_grep "is the first $TERM_BAD commit" "$GIT_DIR/BISECT_RUN" >/dev/null
537 then
538 gettextln "bisect run success"
539 exit 0;
542 done
545 bisect_log () {
546 test -s "$GIT_DIR/BISECT_LOG" || die "$(gettext "We are not bisecting.")"
547 cat "$GIT_DIR/BISECT_LOG"
550 get_terms () {
551 if test -s "$GIT_DIR/BISECT_TERMS"
552 then
554 read TERM_BAD
555 read TERM_GOOD
556 } <"$GIT_DIR/BISECT_TERMS"
560 write_terms () {
561 TERM_BAD=$1
562 TERM_GOOD=$2
563 if test "$TERM_BAD" = "$TERM_GOOD"
564 then
565 die "$(gettext "please use two different terms")"
567 check_term_format "$TERM_BAD" bad
568 check_term_format "$TERM_GOOD" good
569 printf '%s\n%s\n' "$TERM_BAD" "$TERM_GOOD" >"$GIT_DIR/BISECT_TERMS"
572 check_term_format () {
573 term=$1
574 git check-ref-format refs/bisect/"$term" ||
575 die "$(eval_gettext "'\$term' is not a valid term")"
576 case "$term" in
577 help|start|terms|skip|next|reset|visualize|replay|log|run)
578 die "$(eval_gettext "can't use the builtin command '\$term' as a term")"
580 bad|new)
581 if test "$2" != bad
582 then
583 # In theory, nothing prevents swapping
584 # completely good and bad, but this situation
585 # could be confusing and hasn't been tested
586 # enough. Forbid it for now.
587 die "$(eval_gettext "can't change the meaning of term '\$term'")"
590 good|old)
591 if test "$2" != good
592 then
593 die "$(eval_gettext "can't change the meaning of term '\$term'")"
596 esac
599 check_and_set_terms () {
600 cmd="$1"
601 case "$cmd" in
602 skip|start|terms) ;;
604 if test -s "$GIT_DIR/BISECT_TERMS" && test "$cmd" != "$TERM_BAD" && test "$cmd" != "$TERM_GOOD"
605 then
606 die "$(eval_gettext "Invalid command: you're currently in a \$TERM_BAD/\$TERM_GOOD bisect.")"
608 case "$cmd" in
609 bad|good)
610 if ! test -s "$GIT_DIR/BISECT_TERMS"
611 then
612 write_terms bad good
615 new|old)
616 if ! test -s "$GIT_DIR/BISECT_TERMS"
617 then
618 write_terms new old
621 esac ;;
622 esac
625 bisect_voc () {
626 case "$1" in
627 bad) echo "bad|new" ;;
628 good) echo "good|old" ;;
629 esac
632 bisect_terms () {
633 get_terms
634 if ! test -s "$GIT_DIR/BISECT_TERMS"
635 then
636 die "$(gettext "no terms defined")"
638 case "$#" in
640 gettextln "Your current terms are $TERM_GOOD for the old state
641 and $TERM_BAD for the new state."
644 arg=$1
645 case "$arg" in
646 --term-good|--term-old)
647 printf '%s\n' "$TERM_GOOD"
649 --term-bad|--term-new)
650 printf '%s\n' "$TERM_BAD"
653 die "$(eval_gettext "invalid argument \$arg for 'git bisect terms'.
654 Supported options are: --term-good|--term-old and --term-bad|--term-new.")"
656 esac
659 usage ;;
660 esac
663 case "$#" in
665 usage ;;
667 cmd="$1"
668 get_terms
669 shift
670 case "$cmd" in
671 help)
672 git bisect -h ;;
673 start)
674 bisect_start "$@" ;;
675 bad|good|new|old|"$TERM_BAD"|"$TERM_GOOD")
676 bisect_state "$cmd" "$@" ;;
677 skip)
678 bisect_skip "$@" ;;
679 next)
680 # Not sure we want "next" at the UI level anymore.
681 bisect_next "$@" ;;
682 visualize|view)
683 bisect_visualize "$@" ;;
684 reset)
685 bisect_reset "$@" ;;
686 replay)
687 bisect_replay "$@" ;;
688 log)
689 bisect_log ;;
690 run)
691 bisect_run "$@" ;;
692 terms)
693 bisect_terms "$@" ;;
695 usage ;;
696 esac
697 esac