blob: ae3cb013e7d5679bc4c63fe4cea35d40167178c5 [file] [log] [blame]
Linus Torvalds8cc6a082005-07-30 10:08:20 -07001#!/bin/sh
Fredrik Kuivinend0255242005-12-11 10:55:49 +01002
Matthieu Moy21b55e32015-06-29 17:40:34 +02003USAGE='[help|start|bad|good|new|old|terms|skip|next|reset|visualize|replay|log|run]'
Christian Couder243a60f2008-04-11 05:55:21 +02004LONG_USAGE='git bisect help
Jon Seymour6021be82011-08-05 21:31:30 +10005 print this long help message.
Matthieu Moy06e6a742015-06-29 17:40:35 +02006git bisect start [--term-{old,good}=<term> --term-{new,bad}=<term>]
7 [--no-checkout] [<bad> [<good>...]] [--] [<pathspec>...]
Jon Seymour6021be82011-08-05 21:31:30 +10008 reset bisect state and start bisection.
Antoine Delaite21e5cfd2015-06-29 17:40:33 +02009git 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.
Matthieu Moy21b55e32015-06-29 17:40:34 +020015git bisect terms [--term-good | --term-bad]
16 show the terms used for old and new commits (default: bad, good)
Christian Couder54138122008-12-02 14:53:51 +010017git bisect skip [(<rev>|<range>)...]
Jon Seymour6021be82011-08-05 21:31:30 +100018 mark <rev>... untestable revisions.
Christian Couder38a47fd2007-04-04 07:12:02 +020019git bisect next
Jon Seymour6021be82011-08-05 21:31:30 +100020 find next bisection to test and check it out.
Anders Kaseorg6b87ce22009-10-13 17:02:24 -040021git bisect reset [<commit>]
Jon Seymour6021be82011-08-05 21:31:30 +100022 finish bisection search and go back to commit.
Christian Couder38a47fd2007-04-04 07:12:02 +020023git bisect visualize
Jon Seymour6021be82011-08-05 21:31:30 +100024 show bisect status in gitk.
Christian Couder38a47fd2007-04-04 07:12:02 +020025git bisect replay <logfile>
Jon Seymour6021be82011-08-05 21:31:30 +100026 replay bisection log.
Christian Couder38a47fd2007-04-04 07:12:02 +020027git bisect log
Jon Seymour6021be82011-08-05 21:31:30 +100028 show bisect log.
Christian Couder38a47fd2007-04-04 07:12:02 +020029git bisect run <cmd>...
Jon Seymour6021be82011-08-05 21:31:30 +100030 use <cmd>... to automatically bisect.
Christian Couder243a60f2008-04-11 05:55:21 +020031
32Please use "git help bisect" to get the full man page.'
Fredrik Kuivinend0255242005-12-11 10:55:49 +010033
Junio C Hamano8f321a32007-11-06 01:50:02 -080034OPTIONS_SPEC=
Junio C Hamanoae2b0f12005-11-24 00:12:11 -080035. git-sh-setup
Linus Torvalds8cc6a082005-07-30 10:08:20 -070036
Johannes Schindelince326602008-02-10 13:59:50 +000037_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"
Antoine Delaite43f9d9f2015-06-29 17:40:29 +020039TERM_BAD=bad
40TERM_GOOD=good
Johannes Schindelince326602008-02-10 13:59:50 +000041
Jon Seymour4796e822011-08-04 22:01:01 +100042bisect_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
Linus Torvalds8cc6a082005-07-30 10:08:20 -070052bisect_autostart() {
Christian Couder823ea122008-05-28 18:57:02 +020053 test -s "$GIT_DIR/BISECT_START" || {
Jon Seymour3145b1a2011-08-31 09:09:47 +100054 gettextln "You need to start by \"git bisect start\"" >&2
Linus Torvalds8cc6a082005-07-30 10:08:20 -070055 if test -t 0
56 then
Ævar Arnfjörð Bjarmason04de0992011-05-21 18:44:28 +000057 # TRANSLATORS: Make sure to include [Y] and [n] in your
58 # translation. The program will only accept English input
59 # at this point.
Jon Seymour6021be82011-08-05 21:31:30 +100060 gettext "Do you want me to do it for you [Y/n]? " >&2
Linus Torvalds8cc6a082005-07-30 10:08:20 -070061 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() {
Linus Torvalds8cc6a082005-07-30 10:08:20 -070074 #
Jon Seymour4764f462011-08-04 22:00:57 +100075 # Check for one bad and then some good revisions.
76 #
77 has_double_dash=0
78 for arg; do
Jon Seymour6021be82011-08-05 21:31:30 +100079 case "$arg" in --) has_double_dash=1; break ;; esac
Jon Seymour4764f462011-08-04 22:00:57 +100080 done
81 orig_args=$(git rev-parse --sq-quote "$@")
82 bad_seen=0
83 eval=''
Antoine Delaitecb46d632015-06-29 17:40:30 +020084 must_write_terms=0
Matthieu Moy4a6ada32015-06-29 17:40:31 +020085 revs=''
Jon Seymour24c51282011-08-09 12:11:54 +100086 if test "z$(git rev-parse --is-bare-repository)" != zfalse
87 then
88 mode=--no-checkout
89 else
90 mode=''
91 fi
Jon Seymour4764f462011-08-04 22:00:57 +100092 while [ $# -gt 0 ]; do
Jon Seymour6021be82011-08-05 21:31:30 +100093 arg="$1"
94 case "$arg" in
95 --)
96 shift
97 break
Jon Seymour4764f462011-08-04 22:00:57 +100098 ;;
Jon Seymour6021be82011-08-05 21:31:30 +100099 --no-checkout)
100 mode=--no-checkout
101 shift ;;
Matthieu Moy06e6a742015-06-29 17:40:35 +0200102 --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 ;;
Jon Seymour6021be82011-08-05 21:31:30 +1000120 --*)
121 die "$(eval_gettext "unrecognised option: '\$arg'")" ;;
122 *)
123 rev=$(git rev-parse -q --verify "$arg^{commit}") || {
Junio C Hamano43b8ff42011-08-05 10:09:23 -0700124 test $has_double_dash -eq 1 &&
125 die "$(eval_gettext "'\$arg' does not appear to be a valid revision")"
126 break
Jon Seymour6021be82011-08-05 21:31:30 +1000127 }
Matthieu Moy4a6ada32015-06-29 17:40:31 +0200128 revs="$revs $rev"
Jon Seymour6021be82011-08-05 21:31:30 +1000129 shift
130 ;;
Jon Seymour4764f462011-08-04 22:00:57 +1000131 esac
Jon Seymour4764f462011-08-04 22:00:57 +1000132 done
133
Matthieu Moy4a6ada32015-06-29 17:40:31 +0200134 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
Jon Seymour4764f462011-08-04 22:00:57 +1000149 #
Christian Couder634f2462008-05-23 01:28:57 +0200150 # Verify HEAD.
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700151 #
Christian Couder48949a12008-04-16 04:09:49 +0200152 head=$(GIT_DIR="$GIT_DIR" git symbolic-ref -q HEAD) ||
Johannes Schindelince326602008-02-10 13:59:50 +0000153 head=$(GIT_DIR="$GIT_DIR" git rev-parse --verify HEAD) ||
Ævar Arnfjörð Bjarmason9570fc12011-05-21 18:44:23 +0000154 die "$(gettext "Bad HEAD - I need a HEAD")"
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700155
156 #
Christian Couder634f2462008-05-23 01:28:57 +0200157 # 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")
Jon Seymour4796e822011-08-04 22:01:01 +1000164 if test "z$mode" != "z--no-checkout"
165 then
Christian Couder1acf1172011-09-21 07:17:24 +0200166 git checkout "$start_head" -- ||
Alex Henrie9c9b4f22015-01-13 00:44:47 -0700167 die "$(eval_gettext "Checking out '\$start_head' failed. Try 'git bisect reset <valid-branch>'.")"
Jon Seymour4796e822011-08-04 22:01:01 +1000168 fi
Christian Couder634f2462008-05-23 01:28:57 +0200169 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" ] &&
Masanari Iida382d20e2013-11-13 00:17:42 +0900177 die "$(gettext "won't bisect on cg-seek'ed tree")"
Christian Couder634f2462008-05-23 01:28:57 +0200178 start_head="${head#refs/heads/}"
179 ;;
180 *)
Ævar Arnfjörð Bjarmason9570fc12011-05-21 18:44:23 +0000181 die "$(gettext "Bad HEAD - strange symbolic ref")"
Christian Couder634f2462008-05-23 01:28:57 +0200182 ;;
183 esac
184 fi
185
186 #
187 # Get rid of any old bisect state.
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700188 #
Christian Couder823ea122008-05-28 18:57:02 +0200189 bisect_clean_state || exit
Christian Couder38a47fd2007-04-04 07:12:02 +0200190
191 #
Christian Couderba963de2008-05-23 00:39:22 +0200192 # 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 #
Jon Seymour4796e822011-08-04 22:01:01 +1000204 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 } &&
Christian Couderde52f5a2009-04-24 08:29:00 +0200208 git rev-parse --sq-quote "$@" >"$GIT_DIR/BISECT_NAMES" &&
Jon Seymour6ba7acf2011-08-04 22:00:58 +1000209 eval "$eval true" &&
Antoine Delaitecb46d632015-06-29 17:40:30 +0200210 if test $must_write_terms -eq 1
211 then
212 write_terms "$TERM_BAD" "$TERM_GOOD"
213 fi &&
Miklos Vajna6c98c052008-07-11 18:01:29 +0200214 echo "git bisect start$orig_args" >>"$GIT_DIR/BISECT_LOG" || exit
Christian Couderba963de2008-05-23 00:39:22 +0200215 #
216 # Check if we can proceed to the next bisect state.
217 #
Christian Couder38a47fd2007-04-04 07:12:02 +0200218 bisect_auto_next
Christian Couderba963de2008-05-23 00:39:22 +0200219
220 trap '-' 0
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700221}
222
Christian Couder55624f92007-10-24 07:01:05 +0200223bisect_write() {
224 state="$1"
225 rev="$2"
Christian Couder737c74e2007-10-24 07:01:13 +0200226 nolog="$3"
Christian Couder55624f92007-10-24 07:01:05 +0200227 case "$state" in
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200228 "$TERM_BAD")
229 tag="$state" ;;
230 "$TERM_GOOD"|skip)
231 tag="$state"-"$rev" ;;
232 *)
233 die "$(eval_gettext "Bad bisect_write argument: \$state")" ;;
Christian Couder55624f92007-10-24 07:01:05 +0200234 esac
Christian Couderba963de2008-05-23 00:39:22 +0200235 git update-ref "refs/bisect/$tag" "$rev" || exit
Johannes Schindelinf454cdc2008-02-12 19:50:57 +0000236 echo "# $state: $(git show-branch $rev)" >>"$GIT_DIR/BISECT_LOG"
Miklos Vajna6c98c052008-07-11 18:01:29 +0200237 test -n "$nolog" || echo "git bisect $state $rev" >>"$GIT_DIR/BISECT_LOG"
Christian Couder55624f92007-10-24 07:01:05 +0200238}
239
Christian Couderc9c4e2d2008-08-22 05:52:29 +0200240is_expected_rev() {
241 test -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
242 test "$1" = $(cat "$GIT_DIR/BISECT_EXPECTED_REV")
243}
244
Christian Couderc9c4e2d2008-08-22 05:52:29 +0200245check_expected_revs() {
246 for _rev in "$@"; do
Jon Seymoureef12a92011-08-05 21:31:31 +1000247 if ! is_expected_rev "$_rev"
248 then
Christian Couderc9c4e2d2008-08-22 05:52:29 +0200249 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK"
250 rm -f "$GIT_DIR/BISECT_EXPECTED_REV"
251 return
252 fi
253 done
254}
255
Christian Couderee2314f2008-11-23 22:02:49 +0100256bisect_skip() {
Jon Seymour6021be82011-08-05 21:31:30 +1000257 all=''
Christian Couderee2314f2008-11-23 22:02:49 +0100258 for arg in "$@"
259 do
Jon Seymour6021be82011-08-05 21:31:30 +1000260 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
Christian Couderee2314f2008-11-23 22:02:49 +0100269}
270
Christian Couder155fc792007-10-24 07:01:21 +0200271bisect_state() {
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700272 bisect_autostart
Christian Couder155fc792007-10-24 07:01:21 +0200273 state=$1
Antoine Delaitecb46d632015-06-29 17:40:30 +0200274 check_and_set_terms $state
Christian Couder155fc792007-10-24 07:01:21 +0200275 case "$#,$state" in
276 0,*)
Vasco Almeidaf813fb42016-06-17 21:54:14 +0000277 die "Please call 'bisect_state' with at least one argument." ;;
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200278 1,"$TERM_BAD"|1,"$TERM_GOOD"|1,skip)
Vasco Almeida57984dd2016-06-17 20:21:00 +0000279 bisected_head=$(bisect_head)
280 rev=$(git rev-parse --verify "$bisected_head") ||
281 die "$(eval_gettext "Bad rev input: \$bisected_head")"
Christian Couderc9c4e2d2008-08-22 05:52:29 +0200282 bisect_write "$state" "$rev"
283 check_expected_revs "$rev" ;;
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200284 2,"$TERM_BAD"|*,"$TERM_GOOD"|*,skip)
Christian Couder155fc792007-10-24 07:01:21 +0200285 shift
Christian Couder6bc02d52014-12-25 19:25:32 +0100286 hash_list=''
Christian Coudere3389072008-04-12 07:53:59 +0200287 for rev in "$@"
Christian Couder155fc792007-10-24 07:01:21 +0200288 do
Christian Coudera179a302008-04-12 02:17:36 -0700289 sha=$(git rev-parse --verify "$rev^{commit}") ||
Ævar Arnfjörð Bjarmason15eaa042011-05-21 18:44:24 +0000290 die "$(eval_gettext "Bad rev input: \$rev")"
Christian Couder6bc02d52014-12-25 19:25:32 +0100291 hash_list="$hash_list $sha"
Christian Couderd3e54c82008-04-14 05:41:45 +0200292 done
Christian Couder6bc02d52014-12-25 19:25:32 +0100293 for rev in $hash_list
294 do
295 bisect_write "$state" "$rev"
296 done
297 check_expected_revs $hash_list ;;
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200298 *,"$TERM_BAD")
299 die "$(eval_gettext "'git bisect \$TERM_BAD' can take only one argument.")" ;;
Junio C Hamanocc9f24d2005-08-30 12:45:41 -0700300 *)
301 usage ;;
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700302 esac
Christian Couder97e1c512007-10-22 07:48:36 +0200303 bisect_auto_next
304}
305
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700306bisect_next_check() {
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700307 missing_good= missing_bad=
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200308 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
Junio C Hamano6fecf192007-04-05 22:51:14 -0700310
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700311 case "$missing_good,$missing_bad,$1" in
312 ,,*)
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200313 : have both $TERM_GOOD and $TERM_BAD - ok
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700314 ;;
315 *,)
316 # do not have both but not asked to fail - just report.
317 false
318 ;;
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200319 t,,"$TERM_GOOD")
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200320 # have bad (or new) but not good (or old). we could bisect although
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700321 # this is less optimum.
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200322 eval_gettextln "Warning: bisecting only with a \$TERM_BAD commit." >&2
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700323 if test -t 0
324 then
Ævar Arnfjörð Bjarmason04de0992011-05-21 18:44:28 +0000325 # 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
Francis Moreaue5d3afd2008-08-11 19:37:46 +0200329 read yesno
330 case "$yesno" in [Nn]*) exit 1 ;; esac
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700331 fi
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200332 : bisect without $TERM_GOOD...
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700333 ;;
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700334 *)
Antoine Delaitecb46d632015-06-29 17:40:30 +0200335 bad_syn=$(bisect_voc bad)
336 good_syn=$(bisect_voc good)
Ævar Arnfjörð Bjarmasonbe508d32011-05-21 18:44:29 +0000337 if test -s "$GIT_DIR/BISECT_START"
338 then
Antoine Delaitecb46d632015-06-29 17:40:30 +0200339
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
Ævar Arnfjörð Bjarmasonbe508d32011-05-21 18:44:29 +0000342 else
Antoine Delaitecb46d632015-06-29 17:40:30 +0200343 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
Ævar Arnfjörð Bjarmasonbe508d32011-05-21 18:44:29 +0000346 fi
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700347 exit 1 ;;
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700348 esac
349}
350
351bisect_auto_next() {
Junio C Hamano434d0362005-09-17 13:51:03 -0700352 bisect_next_check && bisect_next || :
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700353}
354
355bisect_next() {
Christian Couder8fe26f42007-10-22 07:48:23 +0200356 case "$#" in 0) ;; *) usage ;; esac
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700357 bisect_autostart
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200358 bisect_next_check $TERM_GOOD
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700359
Christian Couder08719842009-05-09 17:55:47 +0200360 # Perform all bisection computation, display and checkout
Jon Seymour4796e822011-08-04 22:01:01 +1000361 git bisect--helper --next-all $(test -f "$GIT_DIR/BISECT_HEAD" && echo --no-checkout)
Christian Couder5a1d31c2009-04-19 11:56:16 +0200362 res=$?
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700363
Jon Seymour6021be82011-08-05 21:31:30 +1000364 # Check if we should exit because bisection is finished
Torstein Heggea7f8b8a2013-04-13 17:22:57 +0200365 if test $res -eq 10
366 then
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200367 bad_rev=$(git show-ref --hash --verify refs/bisect/$TERM_BAD)
Torstein Heggea7f8b8a2013-04-13 17:22:57 +0200368 bad_commit=$(git show-branch $bad_rev)
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200369 echo "# first $TERM_BAD commit: $bad_commit" >>"$GIT_DIR/BISECT_LOG"
Torstein Heggea7f8b8a2013-04-13 17:22:57 +0200370 exit 0
Torstein Heggef989cac2013-04-22 23:02:29 +0200371 elif test $res -eq 2
372 then
373 echo "# only skipped commits left to test" >>"$GIT_DIR/BISECT_LOG"
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200374 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)
Torstein Heggef989cac2013-04-22 23:02:29 +0200376 do
377 skipped_commit=$(git show-branch $skipped)
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200378 echo "# possible first $TERM_BAD commit: $skipped_commit" >>"$GIT_DIR/BISECT_LOG"
Torstein Heggef989cac2013-04-22 23:02:29 +0200379 done
380 exit $res
Torstein Heggea7f8b8a2013-04-13 17:22:57 +0200381 fi
Junio C Hamano0a5280a2007-04-05 23:27:44 -0700382
Christian Couder5a1d31c2009-04-19 11:56:16 +0200383 # Check for an error in the bisection process
384 test $res -ne 0 && exit $res
385
386 return 0
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700387}
388
Junio C Hamanocc9f24d2005-08-30 12:45:41 -0700389bisect_visualize() {
390 bisect_next_check fail
Junio C Hamano235997c2007-12-07 02:25:34 -0800391
392 if test $# = 0
393 then
Jeff Kingc4e4644e2011-03-21 09:14:22 -0400394 if test -n "${DISPLAY+set}${SESSIONNAME+set}${MSYSTEM+set}${SECURITYSESSIONID+set}" &&
Junio C Hamano43b8ff42011-08-05 10:09:23 -0700395 type gitk >/dev/null 2>&1
Jon Seymoureef12a92011-08-05 21:31:31 +1000396 then
Jeff Kingc4e4644e2011-03-21 09:14:22 -0400397 set gitk
398 else
399 set git log
400 fi
Junio C Hamano235997c2007-12-07 02:25:34 -0800401 else
402 case "$1" in
403 git*|tig) ;;
404 -*) set git log "$@" ;;
405 *) set git "$@" ;;
406 esac
407 fi
408
Christian Couderfc13aa32009-11-23 05:16:14 +0100409 eval '"$@"' --bisect -- $(cat "$GIT_DIR/BISECT_NAMES")
Junio C Hamanocc9f24d2005-08-30 12:45:41 -0700410}
411
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700412bisect_reset() {
Christian Couder823ea122008-05-28 18:57:02 +0200413 test -s "$GIT_DIR/BISECT_START" || {
Jon Seymour3145b1a2011-08-31 09:09:47 +1000414 gettextln "We are not bisecting."
Christian Couderfce04992007-11-20 06:39:53 +0100415 return
416 }
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700417 case "$#" in
Christian Couder823ea122008-05-28 18:57:02 +0200418 0) branch=$(cat "$GIT_DIR/BISECT_START") ;;
Jacopo Notarstefano305a2332014-03-04 01:21:43 +0100419 1) git rev-parse --quiet --verify "$1^{commit}" >/dev/null || {
Jon Seymour6021be82011-08-05 21:31:30 +1000420 invalid="$1"
421 die "$(eval_gettext "'\$invalid' is not a valid commit")"
422 }
423 branch="$1" ;;
Christian Couder8fe26f42007-10-22 07:48:23 +0200424 *)
Jon Seymour6021be82011-08-05 21:31:30 +1000425 usage ;;
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700426 esac
Junio C Hamano43b8ff42011-08-05 10:09:23 -0700427
428 if ! test -f "$GIT_DIR/BISECT_HEAD" && ! git checkout "$branch" --
Jon Seymour4796e822011-08-04 22:01:01 +1000429 then
Junio C Hamano43b8ff42011-08-05 10:09:23 -0700430 die "$(eval_gettext "Could not check out original HEAD '\$branch'.
Ævar Arnfjörð Bjarmason15eaa042011-05-21 18:44:24 +0000431Try 'git bisect reset <commit>'.")"
SZEDER Gábor3bb8cf82010-10-10 23:48:57 +0200432 fi
Jon Seymour4796e822011-08-04 22:01:01 +1000433 bisect_clean_state
Junio C Hamanoe204de22005-09-10 15:18:31 -0700434}
435
Christian Couder38a47fd2007-04-04 07:12:02 +0200436bisect_clean_state() {
Christian Couder947a6042007-11-15 08:18:07 +0100437 # There may be some refs packed during bisection.
Christian Couder634f2462008-05-23 01:28:57 +0200438 git for-each-ref --format='%(refname) %(objectname)' refs/bisect/\* |
Christian Couder947a6042007-11-15 08:18:07 +0100439 while read ref hash
440 do
Christian Couder823ea122008-05-28 18:57:02 +0200441 git update-ref -d $ref $hash || exit
Christian Couder947a6042007-11-15 08:18:07 +0100442 done
Christian Couderc9c4e2d2008-08-22 05:52:29 +0200443 rm -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
444 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK" &&
Christian Couder823ea122008-05-28 18:57:02 +0200445 rm -f "$GIT_DIR/BISECT_LOG" &&
446 rm -f "$GIT_DIR/BISECT_NAMES" &&
447 rm -f "$GIT_DIR/BISECT_RUN" &&
Antoine Delaitecb46d632015-06-29 17:40:30 +0200448 rm -f "$GIT_DIR/BISECT_TERMS" &&
Christian Couder9d0cd912008-05-23 00:38:59 +0200449 # Cleanup head-name if it got left by an old version of git-bisect
Christian Couder823ea122008-05-28 18:57:02 +0200450 rm -f "$GIT_DIR/head-name" &&
Jon Seymour4796e822011-08-04 22:01:01 +1000451 git update-ref -d --no-deref BISECT_HEAD &&
452 # clean up BISECT_START last
Christian Couder823ea122008-05-28 18:57:02 +0200453 rm -f "$GIT_DIR/BISECT_START"
Christian Couder38a47fd2007-04-04 07:12:02 +0200454}
455
Junio C Hamanoe204de22005-09-10 15:18:31 -0700456bisect_replay () {
Ævar Arnfjörð Bjarmason55a9fc82011-05-21 18:44:27 +0000457 file="$1"
458 test "$#" -eq 1 || die "$(gettext "No logfile given")"
459 test -r "$file" || die "$(eval_gettext "cannot read \$file for replaying")"
Junio C Hamanoe204de22005-09-10 15:18:31 -0700460 bisect_reset
Miklos Vajna6c98c052008-07-11 18:01:29 +0200461 while read git bisect command rev
Junio C Hamanoe204de22005-09-10 15:18:31 -0700462 do
Elia Pintoc82af122014-06-06 07:55:50 -0700463 test "$git $bisect" = "git bisect" || test "$git" = "git-bisect" || continue
Jon Seymoureef12a92011-08-05 21:31:31 +1000464 if test "$git" = "git-bisect"
465 then
Miklos Vajna6c98c052008-07-11 18:01:29 +0200466 rev="$command"
467 command="$bisect"
468 fi
Antoine Delaitecb46d632015-06-29 17:40:30 +0200469 get_terms
470 check_and_set_terms "$command"
Junio C Hamanoe204de22005-09-10 15:18:31 -0700471 case "$command" in
472 start)
Junio C Hamanoe9a45d72005-11-27 17:42:05 -0800473 cmd="bisect_start $rev"
Christian Couder737c74e2007-10-24 07:01:13 +0200474 eval "$cmd" ;;
Antoine Delaitecb46d632015-06-29 17:40:30 +0200475 "$TERM_GOOD"|"$TERM_BAD"|skip)
Christian Couder737c74e2007-10-24 07:01:13 +0200476 bisect_write "$command" "$rev" ;;
Matthieu Moy21b55e32015-06-29 17:40:34 +0200477 terms)
478 bisect_terms $rev ;;
Junio C Hamanoe204de22005-09-10 15:18:31 -0700479 *)
Ævar Arnfjörð Bjarmason9570fc12011-05-21 18:44:23 +0000480 die "$(gettext "?? what are you talking about?")" ;;
Junio C Hamanoe204de22005-09-10 15:18:31 -0700481 esac
Ævar Arnfjörð Bjarmason55a9fc82011-05-21 18:44:27 +0000482 done <"$file"
Junio C Hamanoe204de22005-09-10 15:18:31 -0700483 bisect_auto_next
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700484}
485
Christian Coudera17c4102007-03-23 08:49:59 +0100486bisect_run () {
Jon Seymour6021be82011-08-05 21:31:30 +1000487 bisect_next_check fail
Christian Couder83020122007-03-27 06:49:57 +0200488
Jon Seymour6021be82011-08-05 21:31:30 +1000489 while true
490 do
491 command="$@"
Jon Seymour3145b1a2011-08-31 09:09:47 +1000492 eval_gettextln "running \$command"
Jon Seymour6021be82011-08-05 21:31:30 +1000493 "$@"
494 res=$?
Christian Coudera17c4102007-03-23 08:49:59 +0100495
Jon Seymour6021be82011-08-05 21:31:30 +1000496 # Check for really bad run error.
Jon Seymoureef12a92011-08-05 21:31:31 +1000497 if [ $res -lt 0 -o $res -ge 128 ]
498 then
Jon Seymour3145b1a2011-08-31 09:09:47 +1000499 eval_gettextln "bisect run failed:
500exit code \$res from '\$command' is < 0 or >= 128" >&2
Jon Seymour6021be82011-08-05 21:31:30 +1000501 exit $res
502 fi
Christian Coudera17c4102007-03-23 08:49:59 +0100503
Jon Seymour6021be82011-08-05 21:31:30 +1000504 # Find current state depending on run success or failure.
505 # A special exit code of 125 means cannot test.
Jon Seymoureef12a92011-08-05 21:31:31 +1000506 if [ $res -eq 125 ]
507 then
Jon Seymour6021be82011-08-05 21:31:30 +1000508 state='skip'
Jon Seymoureef12a92011-08-05 21:31:31 +1000509 elif [ $res -gt 0 ]
510 then
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200511 state="$TERM_BAD"
Jon Seymour6021be82011-08-05 21:31:30 +1000512 else
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200513 state="$TERM_GOOD"
Jon Seymour6021be82011-08-05 21:31:30 +1000514 fi
Christian Coudera17c4102007-03-23 08:49:59 +0100515
Jon Seymour6021be82011-08-05 21:31:30 +1000516 # We have to use a subshell because "bisect_state" can exit.
Jacopo Notarstefano305a2332014-03-04 01:21:43 +0100517 ( bisect_state $state >"$GIT_DIR/BISECT_RUN" )
Jon Seymour6021be82011-08-05 21:31:30 +1000518 res=$?
Christian Coudera17c4102007-03-23 08:49:59 +0100519
Jon Seymour6021be82011-08-05 21:31:30 +1000520 cat "$GIT_DIR/BISECT_RUN"
Christian Coudera17c4102007-03-23 08:49:59 +0100521
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200522 if sane_grep "first $TERM_BAD commit could be any of" "$GIT_DIR/BISECT_RUN" \
Jacopo Notarstefano305a2332014-03-04 01:21:43 +0100523 >/dev/null
Jon Seymoureef12a92011-08-05 21:31:31 +1000524 then
Jon Seymour3145b1a2011-08-31 09:09:47 +1000525 gettextln "bisect run cannot continue any more" >&2
Jon Seymour6021be82011-08-05 21:31:30 +1000526 exit $res
527 fi
Christian Couder71b02512007-10-26 05:39:37 +0200528
Jon Seymoureef12a92011-08-05 21:31:31 +1000529 if [ $res -ne 0 ]
530 then
Jon Seymour3145b1a2011-08-31 09:09:47 +1000531 eval_gettextln "bisect run failed:
532'bisect_state \$state' exited with error code \$res" >&2
Jon Seymour6021be82011-08-05 21:31:30 +1000533 exit $res
534 fi
Christian Coudera17c4102007-03-23 08:49:59 +0100535
Antoine Delaite43f9d9f2015-06-29 17:40:29 +0200536 if sane_grep "is the first $TERM_BAD commit" "$GIT_DIR/BISECT_RUN" >/dev/null
Jon Seymoureef12a92011-08-05 21:31:31 +1000537 then
Jon Seymour3145b1a2011-08-31 09:09:47 +1000538 gettextln "bisect run success"
Jon Seymour6021be82011-08-05 21:31:30 +1000539 exit 0;
540 fi
Christian Coudera17c4102007-03-23 08:49:59 +0100541
Jon Seymour6021be82011-08-05 21:31:30 +1000542 done
Christian Coudera17c4102007-03-23 08:49:59 +0100543}
544
SZEDER Gábor412ff732010-10-10 23:48:56 +0200545bisect_log () {
Ævar Arnfjörð Bjarmason9570fc12011-05-21 18:44:23 +0000546 test -s "$GIT_DIR/BISECT_LOG" || die "$(gettext "We are not bisecting.")"
SZEDER Gábor412ff732010-10-10 23:48:56 +0200547 cat "$GIT_DIR/BISECT_LOG"
548}
Christian Coudera17c4102007-03-23 08:49:59 +0100549
Antoine Delaitecb46d632015-06-29 17:40:30 +0200550get_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
560write_terms () {
561 TERM_BAD=$1
562 TERM_GOOD=$2
Matthieu Moyfe676872015-06-29 17:40:32 +0200563 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
Antoine Delaitecb46d632015-06-29 17:40:30 +0200569 printf '%s\n%s\n' "$TERM_BAD" "$TERM_GOOD" >"$GIT_DIR/BISECT_TERMS"
570}
571
Matthieu Moyfe676872015-06-29 17:40:32 +0200572check_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
Antoine Delaitecb46d632015-06-29 17:40:30 +0200599check_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 ;;
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200615 new|old)
616 if ! test -s "$GIT_DIR/BISECT_TERMS"
617 then
618 write_terms new old
619 fi
620 ;;
Antoine Delaitecb46d632015-06-29 17:40:30 +0200621 esac ;;
622 esac
623}
624
625bisect_voc () {
626 case "$1" in
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200627 bad) echo "bad|new" ;;
628 good) echo "good|old" ;;
Antoine Delaitecb46d632015-06-29 17:40:30 +0200629 esac
630}
631
Matthieu Moy21b55e32015-06-29 17:40:34 +0200632bisect_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
641and $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'.
654Supported options are: --term-good|--term-old and --term-bad|--term-new.")"
655 ;;
656 esac
657 ;;
658 *)
659 usage ;;
660 esac
661}
662
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700663case "$#" in
6640)
Jon Seymour6021be82011-08-05 21:31:30 +1000665 usage ;;
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700666*)
Jon Seymour6021be82011-08-05 21:31:30 +1000667 cmd="$1"
Antoine Delaitecb46d632015-06-29 17:40:30 +0200668 get_terms
Jon Seymour6021be82011-08-05 21:31:30 +1000669 shift
670 case "$cmd" in
671 help)
672 git bisect -h ;;
673 start)
674 bisect_start "$@" ;;
Antoine Delaite21e5cfd2015-06-29 17:40:33 +0200675 bad|good|new|old|"$TERM_BAD"|"$TERM_GOOD")
Jon Seymour6021be82011-08-05 21:31:30 +1000676 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 "$@" ;;
Matthieu Moy21b55e32015-06-29 17:40:34 +0200692 terms)
693 bisect_terms "$@" ;;
Jon Seymour6021be82011-08-05 21:31:30 +1000694 *)
695 usage ;;
696 esac
Linus Torvalds8cc6a082005-07-30 10:08:20 -0700697esac