checkout: report where the new HEAD is upon detaching HEAD
[git/git.git] / git-bisect.sh
CommitLineData
8cc6a083 1#!/bin/sh
d025524d 2
a17c4101 3USAGE='[start|bad|good|next|reset|visualize|replay|log|run]'
d025524d
FK
4LONG_USAGE='git bisect start [<pathspec>] reset bisect state and start bisection.
5git bisect bad [<rev>] mark <rev> a known-bad revision.
6git bisect good [<rev>...] mark <rev>... known-good revisions.
7git bisect next find next bisection to test and check it out.
8git bisect reset [<branch>] finish bisection search and go back to branch.
9git bisect visualize show bisect status in gitk.
a17c4101
CC
10git bisect replay <logfile> replay bisection log.
11git bisect log show bisect log.
12git bisect run <cmd>... use <cmd>... to automatically bisect.'
d025524d 13
ae2b0f15 14. git-sh-setup
4c550686 15require_work_tree
8cc6a083 16
e9a45d75 17sq() {
d9bffc08 18 @@PERL@@ -e '
e9a45d75
JH
19 for (@ARGV) {
20 s/'\''/'\'\\\\\'\''/g;
21 print " '\''$_'\''";
22 }
23 print "\n";
24 ' "$@"
25}
26
8cc6a083
LT
27bisect_autostart() {
28 test -d "$GIT_DIR/refs/bisect" || {
29 echo >&2 'You need to start by "git bisect start"'
30 if test -t 0
31 then
32 echo >&2 -n 'Do you want me to do it for you [Y/n]? '
33 read yesno
34 case "$yesno" in
35 [Nn]*)
36 exit ;;
37 esac
38 bisect_start
39 else
40 exit 1
41 fi
42 }
43}
44
45bisect_start() {
8cc6a083
LT
46 #
47 # Verify HEAD. If we were bisecting before this, reset to the
48 # top-of-line master first!
49 #
8098a178
JH
50 head=$(GIT_DIR="$GIT_DIR" git-symbolic-ref HEAD) ||
51 die "Bad HEAD - I need a symbolic ref"
8cc6a083
LT
52 case "$head" in
53 refs/heads/bisect*)
810255fd
PB
54 if [ -s "$GIT_DIR/head-name" ]; then
55 branch=`cat "$GIT_DIR/head-name"`
56 else
57 branch=master
58 fi
59 git checkout $branch || exit
8cc6a083
LT
60 ;;
61 refs/heads/*)
810255fd
PB
62 [ -s "$GIT_DIR/head-name" ] && die "won't bisect on seeked tree"
63 echo "$head" | sed 's#^refs/heads/##' >"$GIT_DIR/head-name"
8cc6a083
LT
64 ;;
65 *)
8098a178 66 die "Bad HEAD - strange symbolic ref"
8cc6a083
LT
67 ;;
68 esac
69
70 #
71 # Get rid of any old bisect state
72 #
73 rm -f "$GIT_DIR/refs/heads/bisect"
74 rm -rf "$GIT_DIR/refs/bisect/"
75 mkdir "$GIT_DIR/refs/bisect"
e9a45d75 76 {
9754563c 77 printf "git-bisect start"
e9a45d75
JH
78 sq "$@"
79 } >"$GIT_DIR/BISECT_LOG"
80 sq "$@" >"$GIT_DIR/BISECT_NAMES"
8cc6a083
LT
81}
82
83bisect_bad() {
84 bisect_autostart
cc9f24d0
JH
85 case "$#" in
86 0)
87 rev=$(git-rev-parse --verify HEAD) ;;
88 1)
cc65343a 89 rev=$(git-rev-parse --verify "$1^{commit}") ;;
cc9f24d0
JH
90 *)
91 usage ;;
92 esac || exit
e204de28
JH
93 echo "$rev" >"$GIT_DIR/refs/bisect/bad"
94 echo "# bad: "$(git-show-branch $rev) >>"$GIT_DIR/BISECT_LOG"
95 echo "git-bisect bad $rev" >>"$GIT_DIR/BISECT_LOG"
8cc6a083
LT
96 bisect_auto_next
97}
98
99bisect_good() {
100 bisect_autostart
101 case "$#" in
102 0) revs=$(git-rev-parse --verify HEAD) || exit ;;
cc9f24d0
JH
103 *) revs=$(git-rev-parse --revs-only --no-flags "$@") &&
104 test '' != "$revs" || die "Bad rev input: $@" ;;
8cc6a083
LT
105 esac
106 for rev in $revs
107 do
cc65343a 108 rev=$(git-rev-parse --verify "$rev^{commit}") || exit
cc9f24d0 109 echo "$rev" >"$GIT_DIR/refs/bisect/good-$rev"
e204de28
JH
110 echo "# good: "$(git-show-branch $rev) >>"$GIT_DIR/BISECT_LOG"
111 echo "git-bisect good $rev" >>"$GIT_DIR/BISECT_LOG"
8cc6a083
LT
112 done
113 bisect_auto_next
114}
115
116bisect_next_check() {
117 next_ok=no
118 test -f "$GIT_DIR/refs/bisect/bad" &&
119 case "$(cd "$GIT_DIR" && echo refs/bisect/good-*)" in
120 refs/bisect/good-\*) ;;
121 *) next_ok=yes ;;
122 esac
123 case "$next_ok,$1" in
124 no,) false ;;
125 no,fail)
126 echo >&2 'You need to give me at least one good and one bad revisions.'
127 exit 1 ;;
128 *)
129 true ;;
130 esac
131}
132
133bisect_auto_next() {
434d036f 134 bisect_next_check && bisect_next || :
8cc6a083
LT
135}
136
137bisect_next() {
138 case "$#" in 0) ;; *) usage ;; esac
139 bisect_autostart
140 bisect_next_check fail
141 bad=$(git-rev-parse --verify refs/bisect/bad) &&
142 good=$(git-rev-parse --sq --revs-only --not \
143 $(cd "$GIT_DIR" && ls refs/bisect/good-*)) &&
b3cfd939 144 rev=$(eval "git-rev-list --bisect $good $bad -- $(cat $GIT_DIR/BISECT_NAMES)") || exit
670f5fe3
LT
145 if [ -z "$rev" ]; then
146 echo "$bad was both good and bad"
147 exit 1
148 fi
149 if [ "$rev" = "$bad" ]; then
7f47e72f
JH
150 echo "$rev is first bad commit"
151 git-diff-tree --pretty $rev
8cc6a083
LT
152 exit 0
153 fi
b3cfd939 154 nr=$(eval "git-rev-list $rev $good -- $(cat $GIT_DIR/BISECT_NAMES)" | wc -l) || exit
8cc6a083
LT
155 echo "Bisecting: $nr revisions left to test after this"
156 echo "$rev" > "$GIT_DIR/refs/heads/new-bisect"
08f16750 157 git checkout -q new-bisect || exit
8cc6a083 158 mv "$GIT_DIR/refs/heads/new-bisect" "$GIT_DIR/refs/heads/bisect" &&
8098a178 159 GIT_DIR="$GIT_DIR" git-symbolic-ref HEAD refs/heads/bisect
e204de28 160 git-show-branch "$rev"
8cc6a083
LT
161}
162
cc9f24d0
JH
163bisect_visualize() {
164 bisect_next_check fail
e9a45d75
JH
165 not=`cd "$GIT_DIR/refs" && echo bisect/good-*`
166 eval gitk bisect/bad --not $not -- $(cat "$GIT_DIR/BISECT_NAMES")
cc9f24d0
JH
167}
168
8cc6a083
LT
169bisect_reset() {
170 case "$#" in
810255fd
PB
171 0) if [ -s "$GIT_DIR/head-name" ]; then
172 branch=`cat "$GIT_DIR/head-name"`
173 else
174 branch=master
175 fi ;;
8cc6a083
LT
176 1) test -f "$GIT_DIR/refs/heads/$1" || {
177 echo >&2 "$1 does not seem to be a valid branch"
178 exit 1
179 }
180 branch="$1" ;;
181 *)
182 usage ;;
183 esac
9b709e47
PB
184 if git checkout "$branch"; then
185 rm -fr "$GIT_DIR/refs/bisect"
186 rm -f "$GIT_DIR/refs/heads/bisect" "$GIT_DIR/head-name"
187 rm -f "$GIT_DIR/BISECT_LOG"
188 rm -f "$GIT_DIR/BISECT_NAMES"
a17c4101 189 rm -f "$GIT_DIR/BISECT_RUN"
9b709e47 190 fi
e204de28
JH
191}
192
193bisect_replay () {
194 test -r "$1" || {
195 echo >&2 "cannot read $1 for replaying"
196 exit 1
197 }
198 bisect_reset
199 while read bisect command rev
200 do
201 test "$bisect" = "git-bisect" || continue
202 case "$command" in
203 start)
e9a45d75
JH
204 cmd="bisect_start $rev"
205 eval "$cmd"
e204de28
JH
206 ;;
207 good)
208 echo "$rev" >"$GIT_DIR/refs/bisect/good-$rev"
209 echo "# good: "$(git-show-branch $rev) >>"$GIT_DIR/BISECT_LOG"
210 echo "git-bisect good $rev" >>"$GIT_DIR/BISECT_LOG"
211 ;;
212 bad)
213 echo "$rev" >"$GIT_DIR/refs/bisect/bad"
214 echo "# bad: "$(git-show-branch $rev) >>"$GIT_DIR/BISECT_LOG"
215 echo "git-bisect bad $rev" >>"$GIT_DIR/BISECT_LOG"
216 ;;
217 *)
218 echo >&2 "?? what are you talking about?"
219 exit 1 ;;
220 esac
221 done <"$1"
222 bisect_auto_next
8cc6a083
LT
223}
224
a17c4101
CC
225bisect_run () {
226 while true
227 do
228 echo "running $@"
229 "$@"
230 res=$?
231
232 # Check for really bad run error.
233 if [ $res -lt 0 -o $res -ge 128 ]; then
234 echo >&2 "bisect run failed:"
235 echo >&2 "exit code $res from '$@' is < 0 or >= 128"
236 exit $res
237 fi
238
239 # Use "bisect_good" or "bisect_bad"
240 # depending on run success or failure.
241 if [ $res -gt 0 ]; then
242 next_bisect='bisect_bad'
243 else
244 next_bisect='bisect_good'
245 fi
246
247 # We have to use a subshell because bisect_good or
248 # bisect_bad functions can exit.
249 ( $next_bisect > "$GIT_DIR/BISECT_RUN" )
250 res=$?
251
252 cat "$GIT_DIR/BISECT_RUN"
253
254 if [ $res -ne 0 ]; then
255 echo >&2 "bisect run failed:"
256 echo >&2 "$next_bisect exited with error code $res"
257 exit $res
258 fi
259
260 if grep "is first bad commit" "$GIT_DIR/BISECT_RUN" > /dev/null; then
261 echo "bisect run success"
262 exit 0;
263 fi
264
265 done
266}
267
268
8cc6a083
LT
269case "$#" in
2700)
271 usage ;;
272*)
273 cmd="$1"
274 shift
275 case "$cmd" in
276 start)
277 bisect_start "$@" ;;
278 bad)
279 bisect_bad "$@" ;;
280 good)
281 bisect_good "$@" ;;
282 next)
283 # Not sure we want "next" at the UI level anymore.
284 bisect_next "$@" ;;
cc9f24d0
JH
285 visualize)
286 bisect_visualize "$@" ;;
8cc6a083
LT
287 reset)
288 bisect_reset "$@" ;;
e204de28
JH
289 replay)
290 bisect_replay "$@" ;;
291 log)
292 cat "$GIT_DIR/BISECT_LOG" ;;
a17c4101
CC
293 run)
294 bisect_run "$@" ;;
8cc6a083
LT
295 *)
296 usage ;;
297 esac
298esac