]>
git.ipfire.org Git - thirdparty/git.git/blob - git-bisect.sh
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>...]
7 reset bisect state and start bisection.
9 mark <rev> a known-bad revision.
10 git bisect good [<rev>...]
11 mark <rev>... known-good revisions.
12 git bisect skip [(<rev>|<range>)...]
13 mark <rev>... untestable revisions.
15 find next bisection to test and check it out.
16 git bisect reset [<commit>]
17 finish bisection search and go back to commit.
19 show bisect status in gitk.
20 git bisect replay <logfile>
24 git bisect run <cmd>...
25 use <cmd>... to automatically bisect.
27 Please use "git help bisect" to get the full man page.'
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"
37 test -s "$GIT_DIR/BISECT_START" ||
{
38 echo >&2 'You need to start by "git bisect start"'
41 echo >&2 -n 'Do you want me to do it for you [Y/n]? '
58 head=$
(GIT_DIR
="$GIT_DIR" git symbolic-ref
-q HEAD
) ||
59 head=$
(GIT_DIR
="$GIT_DIR" git rev-parse
--verify HEAD
) ||
60 die
"Bad HEAD - I need a HEAD"
63 # Check if we are bisecting.
66 if test -s "$GIT_DIR/BISECT_START"
68 # Reset to the rev from where we started.
69 start_head
=$
(cat "$GIT_DIR/BISECT_START")
70 git checkout
"$start_head" -- ||
exit
72 # Get rev from where we start.
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/}"
83 die
"Bad HEAD - strange symbolic ref"
89 # Get rid of any old bisect state.
91 bisect_clean_state ||
exit
94 # Check for one bad and then some good revisions.
98 case "$arg" in --) has_double_dash
=1; break ;; esac
100 orig_args
=$
(git rev-parse
--sq-quote "$@")
103 while [ $# -gt 0 ]; do
111 rev=$
(git rev-parse
-q --verify "$arg^{commit}") ||
{
112 test $has_double_dash -eq 1 &&
113 die
"'$arg' does not appear to be a valid revision"
117 0) state
='bad' ; bad_seen
=1 ;;
120 eval="$eval bisect_write '$state' '$rev' 'nolog'; "
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".
133 trap 'bisect_clean_state' 0
134 trap 'exit 255' 1 2 3 15
137 # Write new start state.
139 echo "$start_head" >"$GIT_DIR/BISECT_START" &&
140 git rev-parse
--sq-quote "$@" >"$GIT_DIR/BISECT_NAMES" &&
142 echo "git bisect start$orig_args" >>"$GIT_DIR/BISECT_LOG" ||
exit
144 # Check if we can proceed to the next bisect state.
157 good|skip
) tag
="$state"-"$rev" ;;
158 *) die
"Bad bisect_write argument: $state" ;;
160 git update-ref
"refs/bisect/$tag" "$rev" ||
exit
161 echo "# $state: $(git show-branch $rev)" >>"$GIT_DIR/BISECT_LOG"
162 test -n "$nolog" ||
echo "git bisect $state $rev" >>"$GIT_DIR/BISECT_LOG"
166 test -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
167 test "$1" = $
(cat "$GIT_DIR/BISECT_EXPECTED_REV")
170 check_expected_revs
() {
172 if ! is_expected_rev
"$_rev"; then
173 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK"
174 rm -f "$GIT_DIR/BISECT_EXPECTED_REV"
186 revs
=$
(git rev-list
"$arg") || die
"Bad rev input: $arg" ;;
188 revs
=$
(git rev-parse
--sq-quote "$arg") ;;
192 eval bisect_state
'skip' $all
200 die
"Please call 'bisect_state' with at least one argument." ;;
202 rev=$
(git rev-parse
--verify HEAD
) ||
203 die
"Bad rev input: HEAD"
204 bisect_write
"$state" "$rev"
205 check_expected_revs
"$rev" ;;
211 sha
=$
(git rev-parse
--verify "$rev^{commit}") ||
212 die
"Bad rev input: $rev"
213 eval="$eval bisect_write '$state' '$sha'; "
216 check_expected_revs
"$@" ;;
218 die
"'git bisect bad' can take only one argument." ;;
225 bisect_next_check
() {
226 missing_good
= missing_bad
=
227 git show-ref
-q --verify refs
/bisect
/bad || missing_bad
=t
228 test -n "$(git for-each-ref "refs
/bisect
/good-
*")" || missing_good
=t
230 case "$missing_good,$missing_bad,$1" in
232 : have both good and bad
- ok
235 # do not have both but not asked to fail - just report.
239 # have bad but not good. we could bisect although
240 # this is less optimum.
241 echo >&2 'Warning: bisecting only with a bad commit.'
244 printf >&2 'Are you sure [Y/n]? '
246 case "$yesno" in [Nn
]*) exit 1 ;; esac
248 : bisect without good...
252 test -s "$GIT_DIR/BISECT_START" ||
{
253 echo >&2 'You need to start by "git bisect start".'
256 echo >&2 'You '$THEN'need to give me at least one good' \
257 'and one bad revisions.'
258 echo >&2 '(You can use "git bisect bad" and' \
259 '"git bisect good" for that.)'
265 bisect_next_check
&& bisect_next ||
:
269 case "$#" in 0) ;; *) usage
;; esac
271 bisect_next_check good
273 # Perform all bisection computation, display and checkout
274 git bisect--helper
--next-all
277 # Check if we should exit because bisection is finished
278 test $res -eq 10 && exit 0
280 # Check for an error in the bisection process
281 test $res -ne 0 && exit $res
287 bisect_next_check fail
291 case "${DISPLAY+set}${SESSIONNAME+set}${MSYSTEM+set}${SECURITYSESSIONID+set}" in
298 -*) set git log
"$@" ;;
303 eval '"$@"' --bisect -- $
(cat "$GIT_DIR/BISECT_NAMES")
307 test -s "$GIT_DIR/BISECT_START" ||
{
308 echo "We are not bisecting."
312 0) branch
=$
(cat "$GIT_DIR/BISECT_START") ;;
313 1) git rev-parse
--quiet --verify "$1^{commit}" > /dev
/null ||
314 die
"'$1' is not a valid commit"
319 git checkout
"$branch" -- && bisect_clean_state
322 bisect_clean_state
() {
323 # There may be some refs packed during bisection.
324 git for-each-ref
--format='%(refname) %(objectname)' refs
/bisect
/\
* |
327 git update-ref
-d $ref $hash ||
exit
329 rm -f "$GIT_DIR/BISECT_EXPECTED_REV" &&
330 rm -f "$GIT_DIR/BISECT_ANCESTORS_OK" &&
331 rm -f "$GIT_DIR/BISECT_LOG" &&
332 rm -f "$GIT_DIR/BISECT_NAMES" &&
333 rm -f "$GIT_DIR/BISECT_RUN" &&
334 # Cleanup head-name if it got left by an old version of git-bisect
335 rm -f "$GIT_DIR/head-name" &&
337 rm -f "$GIT_DIR/BISECT_START"
341 test -r "$1" || die
"cannot read $1 for replaying"
343 while read git bisect
command rev
345 test "$git $bisect" = "git bisect" -o "$git" = "git-bisect" ||
continue
346 if test "$git" = "git-bisect"; then
352 cmd
="bisect_start $rev"
355 bisect_write
"$command" "$rev" ;;
357 die
"?? what are you talking about?" ;;
364 bisect_next_check fail
372 # Check for really bad run error.
373 if [ $res -lt 0 -o $res -ge 128 ]; then
374 echo >&2 "bisect run failed:"
375 echo >&2 "exit code $res from '$@' is < 0 or >= 128"
379 # Find current state depending on run success or failure.
380 # A special exit code of 125 means cannot test.
381 if [ $res -eq 125 ]; then
383 elif [ $res -gt 0 ]; then
389 # We have to use a subshell because "bisect_state" can exit.
390 ( bisect_state
$state > "$GIT_DIR/BISECT_RUN" )
393 cat "$GIT_DIR/BISECT_RUN"
395 if sane_grep
"first bad commit could be any of" "$GIT_DIR/BISECT_RUN" \
397 echo >&2 "bisect run cannot continue any more"
401 if [ $res -ne 0 ]; then
402 echo >&2 "bisect run failed:"
403 echo >&2 "'bisect_state $state' exited with error code $res"
407 if sane_grep
"is the first bad commit" "$GIT_DIR/BISECT_RUN" > /dev
/null
; then
408 echo "bisect run success"
428 bisect_state
"$cmd" "$@" ;;
432 # Not sure we want "next" at the UI level anymore.
435 bisect_visualize
"$@" ;;
439 bisect_replay
"$@" ;;
441 cat "$GIT_DIR/BISECT_LOG" ;;