]>
Commit | Line | Data |
---|---|---|
8cc6a083 | 1 | #!/bin/sh |
d025524d | 2 | |
243a60fb CC |
3 | USAGE='[help|start|bad|good|skip|next|reset|visualize|replay|log|run]' |
4 | LONG_USAGE='git bisect help | |
5 | print this long help message. | |
6 | git bisect start [<bad> [<good>...]] [--] [<pathspec>...] | |
38a47fd6 CC |
7 | reset bisect state and start bisection. |
8 | git bisect bad [<rev>] | |
9 | mark <rev> a known-bad revision. | |
10 | git bisect good [<rev>...] | |
11 | mark <rev>... known-good revisions. | |
5413812f | 12 | git bisect skip [(<rev>|<range>)...] |
6ca8b977 | 13 | mark <rev>... untestable revisions. |
38a47fd6 CC |
14 | git bisect next |
15 | find next bisection to test and check it out. | |
6b87ce23 AK |
16 | git bisect reset [<commit>] |
17 | finish bisection search and go back to commit. | |
38a47fd6 CC |
18 | git bisect visualize |
19 | show bisect status in gitk. | |
20 | git bisect replay <logfile> | |
21 | replay bisection log. | |
22 | git bisect log | |
23 | show bisect log. | |
24 | git bisect run <cmd>... | |
243a60fb CC |
25 | use <cmd>... to automatically bisect. |
26 | ||
27 | Please use "git help bisect" to get the full man page.' | |
d025524d | 28 | |
8f321a39 | 29 | OPTIONS_SPEC= |
ae2b0f15 | 30 | . git-sh-setup |
dcf9c2e5 | 31 | . git-sh-i18n |
4c550686 | 32 | require_work_tree |
8cc6a083 | 33 | |
ce32660e JS |
34 | _x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]' |
35 | _x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40" | |
36 | ||
8cc6a083 | 37 | bisect_autostart() { |
823ea121 | 38 | test -s "$GIT_DIR/BISECT_START" || { |
ddd7a7c2 ÆAB |
39 | ( |
40 | gettext "You need to start by \"git bisect start\"" && | |
41 | echo | |
42 | ) >&2 | |
8cc6a083 LT |
43 | if test -t 0 |
44 | then | |
45 | echo >&2 -n 'Do you want me to do it for you [Y/n]? ' | |
46 | read yesno | |
47 | case "$yesno" in | |
48 | [Nn]*) | |
49 | exit ;; | |
50 | esac | |
51 | bisect_start | |
52 | else | |
53 | exit 1 | |
54 | fi | |
55 | } | |
56 | } | |
57 | ||
58 | bisect_start() { | |
8cc6a083 | 59 | # |
634f2464 | 60 | # Verify HEAD. |
8cc6a083 | 61 | # |
48949a18 | 62 | head=$(GIT_DIR="$GIT_DIR" git symbolic-ref -q HEAD) || |
ce32660e | 63 | head=$(GIT_DIR="$GIT_DIR" git rev-parse --verify HEAD) || |
9570fc1e | 64 | die "$(gettext "Bad HEAD - I need a HEAD")" |
634f2464 | 65 | |
ee831f7d | 66 | # |
634f2464 | 67 | # Check if we are bisecting. |
ee831f7d | 68 | # |
d3e54c88 | 69 | start_head='' |
634f2464 CC |
70 | if test -s "$GIT_DIR/BISECT_START" |
71 | then | |
72 | # Reset to the rev from where we started. | |
9d0cd91c | 73 | start_head=$(cat "$GIT_DIR/BISECT_START") |
f3a186ff | 74 | git checkout "$start_head" -- || exit |
634f2464 CC |
75 | else |
76 | # Get rev from where we start. | |
77 | case "$head" in | |
78 | refs/heads/*|$_x40) | |
79 | # This error message should only be triggered by | |
80 | # cogito usage, and cogito users should understand | |
81 | # it relates to cg-seek. | |
82 | [ -s "$GIT_DIR/head-name" ] && | |
9570fc1e | 83 | die "$(gettext "won't bisect on seeked tree")" |
634f2464 CC |
84 | start_head="${head#refs/heads/}" |
85 | ;; | |
86 | *) | |
9570fc1e | 87 | die "$(gettext "Bad HEAD - strange symbolic ref")" |
634f2464 CC |
88 | ;; |
89 | esac | |
90 | fi | |
8cc6a083 LT |
91 | |
92 | # | |
634f2464 | 93 | # Get rid of any old bisect state. |
8cc6a083 | 94 | # |
823ea121 | 95 | bisect_clean_state || exit |
38a47fd6 CC |
96 | |
97 | # | |
98 | # Check for one bad and then some good revisions. | |
99 | # | |
100 | has_double_dash=0 | |
101 | for arg; do | |
102 | case "$arg" in --) has_double_dash=1; break ;; esac | |
103 | done | |
de52f5a8 | 104 | orig_args=$(git rev-parse --sq-quote "$@") |
38a47fd6 | 105 | bad_seen=0 |
d3e54c88 | 106 | eval='' |
38a47fd6 CC |
107 | while [ $# -gt 0 ]; do |
108 | arg="$1" | |
109 | case "$arg" in | |
110 | --) | |
8fe26f44 | 111 | shift |
38a47fd6 CC |
112 | break |
113 | ;; | |
114 | *) | |
634f2464 | 115 | rev=$(git rev-parse -q --verify "$arg^{commit}") || { |
38a47fd6 | 116 | test $has_double_dash -eq 1 && |
15eaa049 | 117 | die "$(eval_gettext "'\$arg' does not appear to be a valid revision")" |
38a47fd6 CC |
118 | break |
119 | } | |
737c74ee CC |
120 | case $bad_seen in |
121 | 0) state='bad' ; bad_seen=1 ;; | |
122 | *) state='good' ;; | |
123 | esac | |
d3e54c88 | 124 | eval="$eval bisect_write '$state' '$rev' 'nolog'; " |
8fe26f44 | 125 | shift |
38a47fd6 CC |
126 | ;; |
127 | esac | |
8fe26f44 | 128 | done |
38a47fd6 | 129 | |
ba963de8 CC |
130 | # |
131 | # Change state. | |
132 | # In case of mistaken revs or checkout error, or signals received, | |
133 | # "bisect_auto_next" below may exit or misbehave. | |
134 | # We have to trap this to be able to clean up using | |
135 | # "bisect_clean_state". | |
136 | # | |
137 | trap 'bisect_clean_state' 0 | |
138 | trap 'exit 255' 1 2 3 15 | |
139 | ||
140 | # | |
141 | # Write new start state. | |
142 | # | |
ba963de8 | 143 | echo "$start_head" >"$GIT_DIR/BISECT_START" && |
de52f5a8 | 144 | git rev-parse --sq-quote "$@" >"$GIT_DIR/BISECT_NAMES" && |
ba963de8 | 145 | eval "$eval" && |
6c98c054 | 146 | echo "git bisect start$orig_args" >>"$GIT_DIR/BISECT_LOG" || exit |
ba963de8 CC |
147 | # |
148 | # Check if we can proceed to the next bisect state. | |
149 | # | |
38a47fd6 | 150 | bisect_auto_next |
ba963de8 CC |
151 | |
152 | trap '-' 0 | |
8cc6a083 LT |
153 | } |
154 | ||
55624f9a CC |
155 | bisect_write() { |
156 | state="$1" | |
157 | rev="$2" | |
737c74ee | 158 | nolog="$3" |
55624f9a CC |
159 | case "$state" in |
160 | bad) tag="$state" ;; | |
161 | good|skip) tag="$state"-"$rev" ;; | |
15eaa049 | 162 | *) die "$(eval_gettext "Bad bisect_write argument: \$state")" ;; |
55624f9a | 163 | esac |
ba963de8 | 164 | git update-ref "refs/bisect/$tag" "$rev" || exit |
f454cdc4 | 165 | echo "# $state: $(git show-branch $rev)" >>"$GIT_DIR/BISECT_LOG" |
6c98c054 | 166 | test -n "$nolog" || echo "git bisect $state $rev" >>"$GIT_DIR/BISECT_LOG" |
55624f9a CC |
167 | } |
168 | ||
c9c4e2d5 CC |
169 | is_expected_rev() { |
170 | test -f "$GIT_DIR/BISECT_EXPECTED_REV" && | |
171 | test "$1" = $(cat "$GIT_DIR/BISECT_EXPECTED_REV") | |
172 | } | |
173 | ||
c9c4e2d5 CC |
174 | check_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 |
184 | bisect_skip() { |
185 | all='' | |
186 | for arg in "$@" | |
187 | do | |
188 | case "$arg" in | |
189 | *..*) | |
15eaa049 | 190 | revs=$(git rev-list "$arg") || die "$(eval_gettext "Bad rev input: \$arg")" ;; |
ee2314f5 | 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 | 199 | bisect_state() { |
8cc6a083 | 200 | bisect_autostart |
155fc795 CC |
201 | state=$1 |
202 | case "$#,$state" in | |
203 | 0,*) | |
9570fc1e | 204 | die "$(gettext "Please call 'bisect_state' with at least one argument.")" ;; |
155fc795 CC |
205 | 1,bad|1,good|1,skip) |
206 | rev=$(git rev-parse --verify HEAD) || | |
9570fc1e | 207 | die "$(gettext "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}") || |
15eaa049 | 216 | die "$(eval_gettext "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 | 221 | *,bad) |
9570fc1e | 222 | die "$(gettext "'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 | 229 | bisect_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. | |
ddd7a7c2 ÆAB |
245 | ( |
246 | gettext "Warning: bisecting only with a bad commit." && | |
247 | echo | |
248 | ) >&2 | |
0a5280a9 JH |
249 | if test -t 0 |
250 | then | |
251 | printf >&2 'Are you sure [Y/n]? ' | |
e5d3afd7 FM |
252 | read yesno |
253 | case "$yesno" in [Nn]*) exit 1 ;; esac | |
0a5280a9 JH |
254 | fi |
255 | : bisect without good... | |
256 | ;; | |
8cc6a083 | 257 | *) |
0a5280a9 | 258 | THEN='' |
823ea121 | 259 | test -s "$GIT_DIR/BISECT_START" || { |
0a5280a9 JH |
260 | echo >&2 'You need to start by "git bisect start".' |
261 | THEN='then ' | |
262 | } | |
263 | echo >&2 'You '$THEN'need to give me at least one good' \ | |
264 | 'and one bad revisions.' | |
265 | echo >&2 '(You can use "git bisect bad" and' \ | |
266 | '"git bisect good" for that.)' | |
267 | exit 1 ;; | |
8cc6a083 LT |
268 | esac |
269 | } | |
270 | ||
271 | bisect_auto_next() { | |
434d036f | 272 | bisect_next_check && bisect_next || : |
8cc6a083 LT |
273 | } |
274 | ||
275 | bisect_next() { | |
8fe26f44 | 276 | case "$#" in 0) ;; *) usage ;; esac |
8cc6a083 | 277 | bisect_autostart |
0a5280a9 JH |
278 | bisect_next_check good |
279 | ||
0871984d CC |
280 | # Perform all bisection computation, display and checkout |
281 | git bisect--helper --next-all | |
5a1d31c7 | 282 | res=$? |
0a5280a9 | 283 | |
5a1d31c7 CC |
284 | # Check if we should exit because bisection is finished |
285 | test $res -eq 10 && exit 0 | |
0a5280a9 | 286 | |
5a1d31c7 CC |
287 | # Check for an error in the bisection process |
288 | test $res -ne 0 && exit $res | |
289 | ||
290 | return 0 | |
8cc6a083 LT |
291 | } |
292 | ||
cc9f24d0 JH |
293 | bisect_visualize() { |
294 | bisect_next_check fail | |
235997c9 JH |
295 | |
296 | if test $# = 0 | |
297 | then | |
c4e4644e JK |
298 | if test -n "${DISPLAY+set}${SESSIONNAME+set}${MSYSTEM+set}${SECURITYSESSIONID+set}" && |
299 | type gitk >/dev/null 2>&1; then | |
300 | set gitk | |
301 | else | |
302 | set git log | |
303 | fi | |
235997c9 JH |
304 | else |
305 | case "$1" in | |
306 | git*|tig) ;; | |
307 | -*) set git log "$@" ;; | |
308 | *) set git "$@" ;; | |
309 | esac | |
310 | fi | |
311 | ||
fc13aa3d | 312 | eval '"$@"' --bisect -- $(cat "$GIT_DIR/BISECT_NAMES") |
cc9f24d0 JH |
313 | } |
314 | ||
8cc6a083 | 315 | bisect_reset() { |
823ea121 | 316 | test -s "$GIT_DIR/BISECT_START" || { |
d0238a88 | 317 | gettext "We are not bisecting."; echo |
fce0499f CC |
318 | return |
319 | } | |
8cc6a083 | 320 | case "$#" in |
823ea121 | 321 | 0) branch=$(cat "$GIT_DIR/BISECT_START") ;; |
6b87ce23 AK |
322 | 1) git rev-parse --quiet --verify "$1^{commit}" > /dev/null || |
323 | die "'$1' is not a valid commit" | |
8cc6a083 | 324 | branch="$1" ;; |
8fe26f44 | 325 | *) |
8cc6a083 LT |
326 | usage ;; |
327 | esac | |
3bb8cf88 SG |
328 | if git checkout "$branch" -- ; then |
329 | bisect_clean_state | |
330 | else | |
15eaa049 ÆAB |
331 | die "$(eval_gettext "Could not check out original HEAD '\$branch'. |
332 | Try 'git bisect reset <commit>'.")" | |
3bb8cf88 | 333 | fi |
e204de28 JH |
334 | } |
335 | ||
38a47fd6 | 336 | bisect_clean_state() { |
947a604b | 337 | # There may be some refs packed during bisection. |
634f2464 | 338 | git for-each-ref --format='%(refname) %(objectname)' refs/bisect/\* | |
947a604b CC |
339 | while read ref hash |
340 | do | |
823ea121 | 341 | git update-ref -d $ref $hash || exit |
947a604b | 342 | done |
c9c4e2d5 CC |
343 | rm -f "$GIT_DIR/BISECT_EXPECTED_REV" && |
344 | rm -f "$GIT_DIR/BISECT_ANCESTORS_OK" && | |
823ea121 CC |
345 | rm -f "$GIT_DIR/BISECT_LOG" && |
346 | rm -f "$GIT_DIR/BISECT_NAMES" && | |
347 | rm -f "$GIT_DIR/BISECT_RUN" && | |
9d0cd91c | 348 | # Cleanup head-name if it got left by an old version of git-bisect |
823ea121 CC |
349 | rm -f "$GIT_DIR/head-name" && |
350 | ||
351 | rm -f "$GIT_DIR/BISECT_START" | |
38a47fd6 CC |
352 | } |
353 | ||
e204de28 | 354 | bisect_replay () { |
2c7c3877 | 355 | test "$#" -eq 1 || die "No logfile given" |
737c74ee | 356 | test -r "$1" || die "cannot read $1 for replaying" |
e204de28 | 357 | bisect_reset |
6c98c054 | 358 | while read git bisect command rev |
e204de28 | 359 | do |
6c98c054 MV |
360 | test "$git $bisect" = "git bisect" -o "$git" = "git-bisect" || continue |
361 | if test "$git" = "git-bisect"; then | |
362 | rev="$command" | |
363 | command="$bisect" | |
364 | fi | |
e204de28 JH |
365 | case "$command" in |
366 | start) | |
e9a45d75 | 367 | cmd="bisect_start $rev" |
737c74ee CC |
368 | eval "$cmd" ;; |
369 | good|bad|skip) | |
370 | bisect_write "$command" "$rev" ;; | |
e204de28 | 371 | *) |
9570fc1e | 372 | die "$(gettext "?? what are you talking about?")" ;; |
e204de28 JH |
373 | esac |
374 | done <"$1" | |
375 | bisect_auto_next | |
8cc6a083 LT |
376 | } |
377 | ||
a17c4101 | 378 | bisect_run () { |
83020120 CC |
379 | bisect_next_check fail |
380 | ||
a17c4101 CC |
381 | while true |
382 | do | |
383 | echo "running $@" | |
384 | "$@" | |
385 | res=$? | |
386 | ||
387 | # Check for really bad run error. | |
388 | if [ $res -lt 0 -o $res -ge 128 ]; then | |
389 | echo >&2 "bisect run failed:" | |
390 | echo >&2 "exit code $res from '$@' is < 0 or >= 128" | |
391 | exit $res | |
392 | fi | |
393 | ||
155fc795 | 394 | # Find current state depending on run success or failure. |
71b0251c CC |
395 | # A special exit code of 125 means cannot test. |
396 | if [ $res -eq 125 ]; then | |
397 | state='skip' | |
398 | elif [ $res -gt 0 ]; then | |
155fc795 | 399 | state='bad' |
a17c4101 | 400 | else |
155fc795 | 401 | state='good' |
a17c4101 CC |
402 | fi |
403 | ||
155fc795 CC |
404 | # We have to use a subshell because "bisect_state" can exit. |
405 | ( bisect_state $state > "$GIT_DIR/BISECT_RUN" ) | |
a17c4101 CC |
406 | res=$? |
407 | ||
408 | cat "$GIT_DIR/BISECT_RUN" | |
409 | ||
e1622bfc | 410 | if sane_grep "first bad commit could be any of" "$GIT_DIR/BISECT_RUN" \ |
71b0251c | 411 | > /dev/null; then |
ddd7a7c2 ÆAB |
412 | ( |
413 | gettext "bisect run cannot continue any more" && | |
414 | echo | |
415 | ) >&2 | |
71b0251c CC |
416 | exit $res |
417 | fi | |
418 | ||
a17c4101 | 419 | if [ $res -ne 0 ]; then |
c6649c92 ÆAB |
420 | ( |
421 | eval_gettext "bisect run failed: | |
422 | 'bisect_state \$state' exited with error code \$res" && | |
423 | echo | |
424 | ) >&2 | |
a17c4101 CC |
425 | exit $res |
426 | fi | |
427 | ||
e1622bfc | 428 | if sane_grep "is the first bad commit" "$GIT_DIR/BISECT_RUN" > /dev/null; then |
d0238a88 | 429 | gettext "bisect run success"; echo |
a17c4101 CC |
430 | exit 0; |
431 | fi | |
432 | ||
433 | done | |
434 | } | |
435 | ||
412ff738 | 436 | bisect_log () { |
9570fc1e | 437 | test -s "$GIT_DIR/BISECT_LOG" || die "$(gettext "We are not bisecting.")" |
412ff738 SG |
438 | cat "$GIT_DIR/BISECT_LOG" |
439 | } | |
a17c4101 | 440 | |
8cc6a083 LT |
441 | case "$#" in |
442 | 0) | |
443 | usage ;; | |
444 | *) | |
445 | cmd="$1" | |
446 | shift | |
447 | case "$cmd" in | |
243a60fb CC |
448 | help) |
449 | git bisect -h ;; | |
8cc6a083 LT |
450 | start) |
451 | bisect_start "$@" ;; | |
ee2314f5 | 452 | bad|good) |
155fc795 | 453 | bisect_state "$cmd" "$@" ;; |
ee2314f5 CC |
454 | skip) |
455 | bisect_skip "$@" ;; | |
8cc6a083 LT |
456 | next) |
457 | # Not sure we want "next" at the UI level anymore. | |
458 | bisect_next "$@" ;; | |
235997c9 | 459 | visualize|view) |
cc9f24d0 | 460 | bisect_visualize "$@" ;; |
8cc6a083 LT |
461 | reset) |
462 | bisect_reset "$@" ;; | |
e204de28 JH |
463 | replay) |
464 | bisect_replay "$@" ;; | |
465 | log) | |
412ff738 | 466 | bisect_log ;; |
a17c4101 CC |
467 | run) |
468 | bisect_run "$@" ;; | |
8cc6a083 LT |
469 | *) |
470 | usage ;; | |
471 | esac | |
472 | esac |