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