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.
20 find next bisection to test and check it out.
21 git bisect reset [<commit>]
22 finish bisection search and go back to commit.
24 show bisect status in gitk.
25 git bisect replay <logfile>
29 git bisect run <cmd>...
30 use <cmd>... to automatically bisect.
32 Please use "git help bisect" to get the full man page.'
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"
45 if test -f "$GIT_DIR/BISECT_HEAD"
54 test -s "$GIT_DIR/BISECT_START" ||
{
55 gettextln
"You need to start by \"git bisect start\"" >&2
58 # TRANSLATORS: Make sure to include [Y] and [n] in your
59 # translation. The program will only accept English input
61 gettext "Do you want me to do it for you [Y/n]? " >&2
76 # Check for one bad and then some good revisions.
80 case "$arg" in --) has_double_dash
=1; break ;; esac
82 orig_args
=$
(git rev-parse
--sq-quote "$@")
87 if test "z$(git rev-parse --is-bare-repository)" != zfalse
93 while [ $# -gt 0 ]; do
103 --term-good|
--term-old)
108 --term-good=*|
--term-old=*)
112 --term-bad|
--term-new)
117 --term-bad=*|
--term-new=*)
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
")"
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.
145 0) state
=$TERM_BAD ; bad_seen
=1 ;;
146 *) state
=$TERM_GOOD ;;
148 eval="$eval bisect_write '$state' '$rev' 'nolog' &&"
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.
161 if test -s "$GIT_DIR/BISECT_START"
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"
167 git checkout
"$start_head" -- ||
168 die
"$(eval_gettext "Checking out
'\$start_head' failed. Try
'git bisect reset <valid-branch>'.
")"
171 # Get rev from where we start.
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
")"
188 # Get rid of any old bisect state.
190 bisect_clean_state ||
exit
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"
209 git rev-parse
--sq-quote "$@" >"$GIT_DIR/BISECT_NAMES" &&
211 if test $must_write_terms -eq 1
213 write_terms
"$TERM_BAD" "$TERM_GOOD"
215 echo "git bisect start$orig_args" >>"$GIT_DIR/BISECT_LOG" ||
exit
217 # Check if we can proceed to the next bisect state.
232 tag
="$state"-"$rev" ;;
234 die
"$(eval_gettext "Bad bisect_write argument
: \
$state")" ;;
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"
242 test -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
243 test "$1" = $
(cat "$GIT_DIR/BISECT_EXPECTED_REV")
246 check_expected_revs
() {
248 if ! is_expected_rev
"$_rev"
250 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK"
251 rm -f "$GIT_DIR/BISECT_EXPECTED_REV"
263 revs
=$
(git rev-list
"$arg") || die
"$(eval_gettext "Bad
rev input
: \
$arg")" ;;
265 revs
=$
(git rev-parse
--sq-quote "$arg") ;;
269 eval bisect_state
'skip' $all
275 check_and_set_terms
$state
278 die
"$(gettext "Please call
'bisect_state' with
at least one argument.
")" ;;
279 1,"$TERM_BAD"|
1,"$TERM_GOOD"|
1,skip
)
280 bisected_head
=$
(bisect_head
)
281 rev=$
(git rev-parse
--verify "$bisected_head") ||
282 die
"$(eval_gettext "Bad
rev input
: \
$bisected_head")"
283 bisect_write
"$state" "$rev"
284 check_expected_revs
"$rev" ;;
285 2,"$TERM_BAD"|
*,"$TERM_GOOD"|
*,skip
)
290 sha
=$
(git rev-parse
--verify "$rev^{commit}") ||
291 die
"$(eval_gettext "Bad
rev input
: \
$rev")"
292 hash_list
="$hash_list $sha"
294 for rev in $hash_list
296 bisect_write
"$state" "$rev"
298 check_expected_revs
$hash_list ;;
300 die
"$(eval_gettext "'git bisect \$TERM_BAD' can take only one argument.
")" ;;
307 bisect_next_check
() {
308 missing_good
= missing_bad
=
309 git show-ref
-q --verify refs
/bisect
/$TERM_BAD || missing_bad
=t
310 test -n "$(git for-each-ref "refs
/bisect
/$TERM_GOOD-*")" || missing_good
=t
312 case "$missing_good,$missing_bad,$1" in
314 : have both
$TERM_GOOD and
$TERM_BAD - ok
317 # do not have both but not asked to fail - just report.
321 # have bad (or new) but not good (or old). we could bisect although
322 # this is less optimum.
323 eval_gettextln
"Warning: bisecting only with a \$TERM_BAD commit." >&2
326 # TRANSLATORS: Make sure to include [Y] and [n] in your
327 # translation. The program will only accept English input
329 gettext "Are you sure [Y/n]? " >&2
331 case "$yesno" in [Nn
]*) exit 1 ;; esac
333 : bisect without
$TERM_GOOD...
336 bad_syn
=$
(bisect_voc bad
)
337 good_syn
=$
(bisect_voc good
)
338 if test -s "$GIT_DIR/BISECT_START"
341 eval_gettextln
"You need to give me at least one \$bad_syn and one \$good_syn revision.
342 (You can use \"git bisect \$bad_syn\" and \"git bisect \$good_syn\" for that.)" >&2
344 eval_gettextln
"You need to start by \"git bisect start\".
345 You then need to give me at least one \$good_syn and one \$bad_syn revision.
346 (You can use \"git bisect \$bad_syn\" and \"git bisect \$good_syn\" for that.)" >&2
353 bisect_next_check
&& bisect_next ||
:
357 case "$#" in 0) ;; *) usage
;; esac
359 bisect_next_check
$TERM_GOOD
361 # Perform all bisection computation, display and checkout
362 git bisect--helper
--next-all $
(test -f "$GIT_DIR/BISECT_HEAD" && echo --no-checkout)
365 # Check if we should exit because bisection is finished
368 bad_rev
=$
(git show-ref
--hash --verify refs
/bisect
/$TERM_BAD)
369 bad_commit
=$
(git show-branch
$bad_rev)
370 echo "# first $TERM_BAD commit: $bad_commit" >>"$GIT_DIR/BISECT_LOG"
374 echo "# only skipped commits left to test" >>"$GIT_DIR/BISECT_LOG"
375 good_revs
=$
(git for-each-ref
--format="%(objectname)" "refs/bisect/$TERM_GOOD-*")
376 for skipped
in $
(git rev-list refs
/bisect
/$TERM_BAD --not $good_revs)
378 skipped_commit
=$
(git show-branch
$skipped)
379 echo "# possible first $TERM_BAD commit: $skipped_commit" >>"$GIT_DIR/BISECT_LOG"
384 # Check for an error in the bisection process
385 test $res -ne 0 && exit $res
391 bisect_next_check fail
395 if test -n "${DISPLAY+set}${SESSIONNAME+set}${MSYSTEM+set}${SECURITYSESSIONID+set}" &&
396 type gitk
>/dev
/null
2>&1
405 -*) set git log
"$@" ;;
410 eval '"$@"' --bisect -- $
(cat "$GIT_DIR/BISECT_NAMES")
414 test -s "$GIT_DIR/BISECT_START" ||
{
415 gettextln
"We are not bisecting."
419 0) branch
=$
(cat "$GIT_DIR/BISECT_START") ;;
420 1) git rev-parse
--quiet --verify "$1^{commit}" >/dev
/null ||
{
422 die
"$(eval_gettext "'\$invalid' is not a valid commit
")"
429 if ! test -f "$GIT_DIR/BISECT_HEAD" && ! git checkout
"$branch" --
431 die
"$(eval_gettext "Could not check out original HEAD
'\$branch'.
432 Try
'git bisect reset <commit>'.
")"
437 bisect_clean_state
() {
438 # There may be some refs packed during bisection.
439 git for-each-ref
--format='%(refname) %(objectname)' refs
/bisect
/\
* |
442 git update-ref
-d $ref $hash ||
exit
444 rm -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
445 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK" &&
446 rm -f "$GIT_DIR/BISECT_LOG" &&
447 rm -f "$GIT_DIR/BISECT_NAMES" &&
448 rm -f "$GIT_DIR/BISECT_RUN" &&
449 rm -f "$GIT_DIR/BISECT_TERMS" &&
450 # Cleanup head-name if it got left by an old version of git-bisect
451 rm -f "$GIT_DIR/head-name" &&
452 git update-ref
-d --no-deref BISECT_HEAD
&&
453 # clean up BISECT_START last
454 rm -f "$GIT_DIR/BISECT_START"
459 test "$#" -eq 1 || die
"$(gettext "No logfile given
")"
460 test -r "$file" || die
"$(eval_gettext "cannot
read \
$file for replaying
")"
462 while read git bisect
command rev
464 test "$git $bisect" = "git bisect" ||
test "$git" = "git-bisect" ||
continue
465 if test "$git" = "git-bisect"
471 check_and_set_terms
"$command"
474 cmd
="bisect_start $rev"
476 "$TERM_GOOD"|
"$TERM_BAD"|skip
)
477 bisect_write
"$command" "$rev" ;;
481 die
"$(gettext "?? what are you talking about?
")" ;;
488 bisect_next_check fail
493 eval_gettextln
"running \$command"
497 # Check for really bad run error.
498 if [ $res -lt 0 -o $res -ge 128 ]
500 eval_gettextln
"bisect run failed:
501 exit code \$res from '\$command' is < 0 or >= 128" >&2
505 # Find current state depending on run success or failure.
506 # A special exit code of 125 means cannot test.
517 # We have to use a subshell because "bisect_state" can exit.
518 ( bisect_state
$state >"$GIT_DIR/BISECT_RUN" )
521 cat "$GIT_DIR/BISECT_RUN"
523 if sane_grep
"first $TERM_BAD commit could be any of" "$GIT_DIR/BISECT_RUN" \
526 gettextln
"bisect run cannot continue any more" >&2
532 eval_gettextln
"bisect run failed:
533 'bisect_state \$state' exited with error code \$res" >&2
537 if sane_grep
"is the first $TERM_BAD commit" "$GIT_DIR/BISECT_RUN" >/dev
/null
539 gettextln
"bisect run success"
547 test -s "$GIT_DIR/BISECT_LOG" || die
"$(gettext "We are not bisecting.
")"
548 cat "$GIT_DIR/BISECT_LOG"
552 if test -s "$GIT_DIR/BISECT_TERMS"
557 } <"$GIT_DIR/BISECT_TERMS"
564 if test "$TERM_BAD" = "$TERM_GOOD"
566 die
"$(gettext "please use two different terms
")"
568 check_term_format
"$TERM_BAD" bad
569 check_term_format
"$TERM_GOOD" good
570 printf '%s\n%s\n' "$TERM_BAD" "$TERM_GOOD" >"$GIT_DIR/BISECT_TERMS"
573 check_term_format
() {
575 git check-ref-format refs
/bisect
/"$term" ||
576 die
"$(eval_gettext "'\$term' is not a valid term
")"
578 help|start|terms|skip|next|
reset|visualize|replay|log|run
)
579 die
"$(eval_gettext "can
't use the builtin command '\
$term' as a term")"
584 # In theory, nothing prevents swapping
585 # completely good and bad, but this situation
586 # could be confusing and hasn't been tested
587 # enough. Forbid it for now.
588 die
"$(eval_gettext "can
't change the meaning of term '\
$term'")"
594 die "$(eval_gettext "can't change the meaning of term
'\$term'")"
600 check_and_set_terms
() {
605 if test -s "$GIT_DIR/BISECT_TERMS" && test "$cmd" != "$TERM_BAD" && test "$cmd" != "$TERM_GOOD"
607 die
"$(eval_gettext "Invalid
command: you
're currently in a \$TERM_BAD/\$TERM_GOOD bisect.")"
611 if ! test -s "$GIT_DIR/BISECT_TERMS"
617 if ! test -s "$GIT_DIR/BISECT_TERMS"
628 bad) echo "bad|new" ;;
629 good) echo "good|old" ;;
635 if ! test -s "$GIT_DIR/BISECT_TERMS"
637 die "$(gettext "no terms defined")"
641 gettextln "Your current terms are $TERM_GOOD for the old state
642 and $TERM_BAD for the new state."
647 --term-good|--term-old)
648 printf '%s
\n' "$TERM_GOOD"
650 --term-bad|--term-new)
651 printf '%s
\n' "$TERM_BAD"
654 die "$(eval_gettext "invalid argument \$arg for 'git bisect terms
'.
655 Supported options are: --term-good|--term-old and --term-bad|--term-new.")"
676 bad|good|new|old|"$TERM_BAD"|"$TERM_GOOD")
677 bisect_state "$cmd" "$@" ;;
681 # Not sure we want "next" at the UI level anymore.
684 bisect_visualize "$@" ;;
688 bisect_replay "$@" ;;