git-bisect.shon commit Bisect: fix some white spaces and empty lines breakages. (8fe26f4)
   1#!/bin/sh
   2
   3USAGE='[start|bad|good|next|reset|visualize|replay|log|run]'
   4LONG_USAGE='git bisect start [<bad> [<good>...]] [--] [<pathspec>...]
   5        reset bisect state and start bisection.
   6git bisect bad [<rev>]
   7        mark <rev> a known-bad revision.
   8git bisect good [<rev>...]
   9        mark <rev>... known-good revisions.
  10git bisect next
  11        find next bisection to test and check it out.
  12git bisect reset [<branch>]
  13        finish bisection search and go back to branch.
  14git bisect visualize
  15        show bisect status in gitk.
  16git bisect replay <logfile>
  17        replay bisection log.
  18git bisect log
  19        show bisect log.
  20git bisect run <cmd>...
  21        use <cmd>... to automatically bisect.'
  22
  23. git-sh-setup
  24require_work_tree
  25
  26sq() {
  27        @@PERL@@ -e '
  28                for (@ARGV) {
  29                        s/'\''/'\'\\\\\'\''/g;
  30                        print " '\''$_'\''";
  31                }
  32                print "\n";
  33        ' "$@"
  34}
  35
  36bisect_autostart() {
  37        test -d "$GIT_DIR/refs/bisect" || {
  38                echo >&2 'You need to start by "git bisect start"'
  39                if test -t 0
  40                then
  41                        echo >&2 -n 'Do you want me to do it for you [Y/n]? '
  42                        read yesno
  43                        case "$yesno" in
  44                        [Nn]*)
  45                                exit ;;
  46                        esac
  47                        bisect_start
  48                else
  49                        exit 1
  50                fi
  51        }
  52}
  53
  54bisect_start() {
  55        #
  56        # Verify HEAD. If we were bisecting before this, reset to the
  57        # top-of-line master first!
  58        #
  59        head=$(GIT_DIR="$GIT_DIR" git symbolic-ref HEAD) ||
  60        die "Bad HEAD - I need a symbolic ref"
  61        case "$head" in
  62        refs/heads/bisect)
  63                if [ -s "$GIT_DIR/head-name" ]; then
  64                    branch=`cat "$GIT_DIR/head-name"`
  65                else
  66                    branch=master
  67                fi
  68                git checkout $branch || exit
  69                ;;
  70        refs/heads/*)
  71                [ -s "$GIT_DIR/head-name" ] && die "won't bisect on seeked tree"
  72                echo "$head" | sed 's#^refs/heads/##' >"$GIT_DIR/head-name"
  73                ;;
  74        *)
  75                die "Bad HEAD - strange symbolic ref"
  76                ;;
  77        esac
  78
  79        #
  80        # Get rid of any old bisect state
  81        #
  82        bisect_clean_state
  83        mkdir "$GIT_DIR/refs/bisect"
  84
  85        #
  86        # Check for one bad and then some good revisions.
  87        #
  88        has_double_dash=0
  89        for arg; do
  90            case "$arg" in --) has_double_dash=1; break ;; esac
  91        done
  92        orig_args=$(sq "$@")
  93        bad_seen=0
  94        while [ $# -gt 0 ]; do
  95            arg="$1"
  96            case "$arg" in
  97            --)
  98                shift
  99                break
 100                ;;
 101            *)
 102                rev=$(git rev-parse --verify "$arg^{commit}" 2>/dev/null) || {
 103                    test $has_double_dash -eq 1 &&
 104                        die "'$arg' does not appear to be a valid revision"
 105                    break
 106                }
 107                if [ $bad_seen -eq 0 ]; then
 108                    bad_seen=1
 109                    bisect_write_bad "$rev"
 110                else
 111                    bisect_write_good "$rev"
 112                fi
 113                shift
 114                ;;
 115            esac
 116        done
 117
 118        sq "$@" >"$GIT_DIR/BISECT_NAMES"
 119        echo "git-bisect start$orig_args" >>"$GIT_DIR/BISECT_LOG"
 120        bisect_auto_next
 121}
 122
 123bisect_bad() {
 124        bisect_autostart
 125        case "$#" in
 126        0)
 127                rev=$(git rev-parse --verify HEAD) ;;
 128        1)
 129                rev=$(git rev-parse --verify "$1^{commit}") ;;
 130        *)
 131                usage ;;
 132        esac || exit
 133        bisect_write_bad "$rev"
 134        echo "git-bisect bad $rev" >>"$GIT_DIR/BISECT_LOG"
 135        bisect_auto_next
 136}
 137
 138bisect_write_bad() {
 139        rev="$1"
 140        echo "$rev" >"$GIT_DIR/refs/bisect/bad"
 141        echo "# bad: "$(git show-branch $rev) >>"$GIT_DIR/BISECT_LOG"
 142}
 143
 144bisect_good() {
 145        bisect_autostart
 146        case "$#" in
 147        0)    revs=$(git rev-parse --verify HEAD) || exit ;;
 148        *)    revs=$(git rev-parse --revs-only --no-flags "$@") &&
 149                test '' != "$revs" || die "Bad rev input: $@" ;;
 150        esac
 151        for rev in $revs
 152        do
 153                rev=$(git rev-parse --verify "$rev^{commit}") || exit
 154                bisect_write_good "$rev"
 155                echo "git-bisect good $rev" >>"$GIT_DIR/BISECT_LOG"
 156        done
 157        bisect_auto_next
 158}
 159
 160bisect_write_good() {
 161        rev="$1"
 162        echo "$rev" >"$GIT_DIR/refs/bisect/good-$rev"
 163        echo "# good: "$(git show-branch $rev) >>"$GIT_DIR/BISECT_LOG"
 164}
 165
 166bisect_next_check() {
 167        missing_good= missing_bad=
 168        git show-ref -q --verify refs/bisect/bad || missing_bad=t
 169        test -n "$(git for-each-ref "refs/bisect/good-*")" || missing_good=t
 170
 171        case "$missing_good,$missing_bad,$1" in
 172        ,,*)
 173                : have both good and bad - ok
 174                ;;
 175        *,)
 176                # do not have both but not asked to fail - just report.
 177                false
 178                ;;
 179        t,,good)
 180                # have bad but not good.  we could bisect although
 181                # this is less optimum.
 182                echo >&2 'Warning: bisecting only with a bad commit.'
 183                if test -t 0
 184                then
 185                        printf >&2 'Are you sure [Y/n]? '
 186                        case "$(read yesno)" in [Nn]*) exit 1 ;; esac
 187                fi
 188                : bisect without good...
 189                ;;
 190        *)
 191                THEN=''
 192                test -d "$GIT_DIR/refs/bisect" || {
 193                        echo >&2 'You need to start by "git bisect start".'
 194                        THEN='then '
 195                }
 196                echo >&2 'You '$THEN'need to give me at least one good' \
 197                        'and one bad revisions.'
 198                echo >&2 '(You can use "git bisect bad" and' \
 199                        '"git bisect good" for that.)'
 200                exit 1 ;;
 201        esac
 202}
 203
 204bisect_auto_next() {
 205        bisect_next_check && bisect_next || :
 206}
 207
 208bisect_next() {
 209        case "$#" in 0) ;; *) usage ;; esac
 210        bisect_autostart
 211        bisect_next_check good
 212
 213        bad=$(git rev-parse --verify refs/bisect/bad) &&
 214        good=$(git for-each-ref --format='^%(objectname)' \
 215                "refs/bisect/good-*" | tr '[\012]' ' ') &&
 216        eval="git rev-list --bisect-vars $good $bad --" &&
 217        eval="$eval $(cat "$GIT_DIR/BISECT_NAMES")" &&
 218        eval=$(eval "$eval") &&
 219        eval "$eval" || exit
 220
 221        if [ -z "$bisect_rev" ]; then
 222                echo "$bad was both good and bad"
 223                exit 1
 224        fi
 225        if [ "$bisect_rev" = "$bad" ]; then
 226                echo "$bisect_rev is first bad commit"
 227                git diff-tree --pretty $bisect_rev
 228                exit 0
 229        fi
 230
 231        echo "Bisecting: $bisect_nr revisions left to test after this"
 232        echo "$bisect_rev" >"$GIT_DIR/refs/heads/new-bisect"
 233        git checkout -q new-bisect || exit
 234        mv "$GIT_DIR/refs/heads/new-bisect" "$GIT_DIR/refs/heads/bisect" &&
 235        GIT_DIR="$GIT_DIR" git symbolic-ref HEAD refs/heads/bisect
 236        git show-branch "$bisect_rev"
 237}
 238
 239bisect_visualize() {
 240        bisect_next_check fail
 241        not=`cd "$GIT_DIR/refs" && echo bisect/good-*`
 242        eval gitk bisect/bad --not $not -- $(cat "$GIT_DIR/BISECT_NAMES")
 243}
 244
 245bisect_reset() {
 246        case "$#" in
 247        0) if [ -s "$GIT_DIR/head-name" ]; then
 248               branch=`cat "$GIT_DIR/head-name"`
 249           else
 250               branch=master
 251           fi ;;
 252        1) git show-ref --verify --quiet -- "refs/heads/$1" || {
 253               echo >&2 "$1 does not seem to be a valid branch"
 254               exit 1
 255           }
 256           branch="$1" ;;
 257        *)
 258            usage ;;
 259        esac
 260        if git checkout "$branch"; then
 261                rm -f "$GIT_DIR/head-name"
 262                bisect_clean_state
 263        fi
 264}
 265
 266bisect_clean_state() {
 267        rm -fr "$GIT_DIR/refs/bisect"
 268        rm -f "$GIT_DIR/refs/heads/bisect"
 269        rm -f "$GIT_DIR/BISECT_LOG"
 270        rm -f "$GIT_DIR/BISECT_NAMES"
 271        rm -f "$GIT_DIR/BISECT_RUN"
 272}
 273
 274bisect_replay () {
 275        test -r "$1" || {
 276                echo >&2 "cannot read $1 for replaying"
 277                exit 1
 278        }
 279        bisect_reset
 280        while read bisect command rev
 281        do
 282                test "$bisect" = "git-bisect" || continue
 283                case "$command" in
 284                start)
 285                        cmd="bisect_start $rev"
 286                        eval "$cmd"
 287                        ;;
 288                good)
 289                        echo "$rev" >"$GIT_DIR/refs/bisect/good-$rev"
 290                        echo "# good: "$(git show-branch $rev) >>"$GIT_DIR/BISECT_LOG"
 291                        echo "git-bisect good $rev" >>"$GIT_DIR/BISECT_LOG"
 292                        ;;
 293                bad)
 294                        echo "$rev" >"$GIT_DIR/refs/bisect/bad"
 295                        echo "# bad: "$(git show-branch $rev) >>"$GIT_DIR/BISECT_LOG"
 296                        echo "git-bisect bad $rev" >>"$GIT_DIR/BISECT_LOG"
 297                        ;;
 298                *)
 299                        echo >&2 "?? what are you talking about?"
 300                        exit 1 ;;
 301                esac
 302        done <"$1"
 303        bisect_auto_next
 304}
 305
 306bisect_run () {
 307    bisect_next_check fail
 308
 309    while true
 310    do
 311      echo "running $@"
 312      "$@"
 313      res=$?
 314
 315      # Check for really bad run error.
 316      if [ $res -lt 0 -o $res -ge 128 ]; then
 317          echo >&2 "bisect run failed:"
 318          echo >&2 "exit code $res from '$@' is < 0 or >= 128"
 319          exit $res
 320      fi
 321
 322      # Use "bisect_good" or "bisect_bad"
 323      # depending on run success or failure.
 324      if [ $res -gt 0 ]; then
 325          next_bisect='bisect_bad'
 326      else
 327          next_bisect='bisect_good'
 328      fi
 329
 330      # We have to use a subshell because bisect_good or
 331      # bisect_bad functions can exit.
 332      ( $next_bisect > "$GIT_DIR/BISECT_RUN" )
 333      res=$?
 334
 335      cat "$GIT_DIR/BISECT_RUN"
 336
 337      if [ $res -ne 0 ]; then
 338          echo >&2 "bisect run failed:"
 339          echo >&2 "$next_bisect exited with error code $res"
 340          exit $res
 341      fi
 342
 343      if grep "is first bad commit" "$GIT_DIR/BISECT_RUN" > /dev/null; then
 344          echo "bisect run success"
 345          exit 0;
 346      fi
 347
 348    done
 349}
 350
 351
 352case "$#" in
 3530)
 354    usage ;;
 355*)
 356    cmd="$1"
 357    shift
 358    case "$cmd" in
 359    start)
 360        bisect_start "$@" ;;
 361    bad)
 362        bisect_bad "$@" ;;
 363    good)
 364        bisect_good "$@" ;;
 365    next)
 366        # Not sure we want "next" at the UI level anymore.
 367        bisect_next "$@" ;;
 368    visualize)
 369        bisect_visualize "$@" ;;
 370    reset)
 371        bisect_reset "$@" ;;
 372    replay)
 373        bisect_replay "$@" ;;
 374    log)
 375        cat "$GIT_DIR/BISECT_LOG" ;;
 376    run)
 377        bisect_run "$@" ;;
 378    *)
 379        usage ;;
 380    esac
 381esac