Replace Free Software Foundation address in license notices
[git] / git-bisect.sh
1 #!/bin/sh
2
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.
31
32 Please use "git help bisect" to get the full man page.'
33
34 OPTIONS_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"
39 TERM_BAD=bad
40 TERM_GOOD=good
41
42 bisect_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
52 bisect_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
73 bisect_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         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 '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                 write_terms "$TERM_BAD" "$TERM_GOOD"
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
223 bisect_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
240 is_expected_rev() {
241         test -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
242         test "$1" = $(cat "$GIT_DIR/BISECT_EXPECTED_REV")
243 }
244
245 check_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
256 bisect_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
271 bisect_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
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
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\".
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
346                 fi
347                 exit 1 ;;
348         esac
349 }
350
351 bisect_auto_next() {
352         bisect_next_check && bisect_next || :
353 }
354
355 bisect_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
389 bisect_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
412 bisect_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'.
431 Try 'git bisect reset <commit>'.")"
432         fi
433         bisect_clean_state
434 }
435
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
440         do
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"
454 }
455
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
462         do
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"
468                 fi
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 ;;
479                 *)
480                         die "$(gettext "?? what are you talking about?")" ;;
481                 esac
482         done <"$file"
483         bisect_auto_next
484 }
485
486 bisect_run () {
487         bisect_next_check fail
488
489         while true
490         do
491                 command="$@"
492                 eval_gettextln "running \$command"
493                 "$@"
494                 res=$?
495
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
502                 fi
503
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"
514                 fi
515
516                 # We have to use a subshell because "bisect_state" can exit.
517                 ( bisect_state $state >"$GIT_DIR/BISECT_RUN" )
518                 res=$?
519
520                 cat "$GIT_DIR/BISECT_RUN"
521
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
527                 fi
528
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
534                 fi
535
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;
540                 fi
541
542         done
543 }
544
545 bisect_log () {
546         test -s "$GIT_DIR/BISECT_LOG" || die "$(gettext "We are not bisecting.")"
547         cat "$GIT_DIR/BISECT_LOG"
548 }
549
550 get_terms () {
551         if test -s "$GIT_DIR/BISECT_TERMS"
552         then
553                 {
554                 read TERM_BAD
555                 read TERM_GOOD
556                 } <"$GIT_DIR/BISECT_TERMS"
557         fi
558 }
559
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")"
566         fi
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"
570 }
571
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")"
579                 ;;
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'")"
588                 fi
589                 ;;
590         good|old)
591                 if test "$2" != good
592                 then
593                         die "$(eval_gettext "can't change the meaning of term '\$term'")"
594                 fi
595                 ;;
596         esac
597 }
598
599 check_and_set_terms () {
600         cmd="$1"
601         case "$cmd" in
602         skip|start|terms) ;;
603         *)
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.")"
607                 fi
608                 case "$cmd" in
609                 bad|good)
610                         if ! test -s "$GIT_DIR/BISECT_TERMS"
611                         then
612                                 write_terms bad good
613                         fi
614                         ;;
615                 new|old)
616                         if ! test -s "$GIT_DIR/BISECT_TERMS"
617                         then
618                                 write_terms new old
619                         fi
620                         ;;
621                 esac ;;
622         esac
623 }
624
625 bisect_voc () {
626         case "$1" in
627         bad) echo "bad|new" ;;
628         good) echo "good|old" ;;
629         esac
630 }
631
632 bisect_terms () {
633         get_terms
634         if ! test -s "$GIT_DIR/BISECT_TERMS"
635         then
636                 die "$(gettext "no terms defined")"
637         fi
638         case "$#" in
639         0)
640                 gettextln "Your current terms are $TERM_GOOD for the old state
641 and $TERM_BAD for the new state."
642                 ;;
643         1)
644                 arg=$1
645                 case "$arg" in
646                         --term-good|--term-old)
647                                 printf '%s\n' "$TERM_GOOD"
648                                 ;;
649                         --term-bad|--term-new)
650                                 printf '%s\n' "$TERM_BAD"
651                                 ;;
652                         *)
653                                 die "$(eval_gettext "invalid argument \$arg for 'git bisect terms'.
654 Supported options are: --term-good|--term-old and --term-bad|--term-new.")"
655                                 ;;
656                 esac
657                 ;;
658         *)
659                 usage ;;
660         esac
661 }
662
663 case "$#" in
664 0)
665         usage ;;
666 *)
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 "$@" ;;
694         *)
695                 usage ;;
696         esac
697 esac