git-rebase.shon commit git-reflog: document --verbose (a5d4101)
   1#!/bin/sh
   2#
   3# Copyright (c) 2005 Junio C Hamano.
   4#
   5
   6USAGE='[--interactive | -i] [-v] [--onto <newbase>] <upstream> [<branch>]'
   7LONG_USAGE='git-rebase replaces <branch> with a new branch of the
   8same name.  When the --onto option is provided the new branch starts
   9out with a HEAD equal to <newbase>, otherwise it is equal to <upstream>
  10It then attempts to create a new commit for each commit from the original
  11<branch> that does not exist in the <upstream> branch.
  12
  13It is possible that a merge failure will prevent this process from being
  14completely automatic.  You will have to resolve any such merge failure
  15and run git rebase --continue.  Another option is to bypass the commit
  16that caused the merge failure with git rebase --skip.  To restore the
  17original <branch> and remove the .dotest working files, use the command
  18git rebase --abort instead.
  19
  20Note that if <branch> is not specified on the command line, the
  21currently checked out branch is used.  You must be in the top
  22directory of your project to start (or continue) a rebase.
  23
  24Example:       git-rebase master~1 topic
  25
  26        A---B---C topic                   A'\''--B'\''--C'\'' topic
  27       /                   -->           /
  28  D---E---F---G master          D---E---F---G master
  29'
  30
  31SUBDIRECTORY_OK=Yes
  32. git-sh-setup
  33set_reflog_action rebase
  34require_work_tree
  35cd_to_toplevel
  36
  37RESOLVEMSG="
  38When you have resolved this problem run \"git rebase --continue\".
  39If you would prefer to skip this patch, instead run \"git rebase --skip\".
  40To restore the original branch and stop rebasing run \"git rebase --abort\".
  41"
  42unset newbase
  43strategy=recursive
  44do_merge=
  45dotest=$GIT_DIR/.dotest-merge
  46prec=4
  47verbose=
  48git_am_opt=
  49
  50continue_merge () {
  51        test -n "$prev_head" || die "prev_head must be defined"
  52        test -d "$dotest" || die "$dotest directory does not exist"
  53
  54        unmerged=$(git ls-files -u)
  55        if test -n "$unmerged"
  56        then
  57                echo "You still have unmerged paths in your index"
  58                echo "did you forget to use git add?"
  59                die "$RESOLVEMSG"
  60        fi
  61
  62        cmt=`cat $dotest/current`
  63        if ! git diff-index --quiet HEAD
  64        then
  65                if ! git-commit -C "$cmt"
  66                then
  67                        echo "Commit failed, please do not call \"git commit\""
  68                        echo "directly, but instead do one of the following: "
  69                        die "$RESOLVEMSG"
  70                fi
  71                printf "Committed: %0${prec}d " $msgnum
  72        else
  73                printf "Already applied: %0${prec}d " $msgnum
  74        fi
  75        git rev-list --pretty=oneline -1 "$cmt" | sed -e 's/^[^ ]* //'
  76
  77        prev_head=`git rev-parse HEAD^0`
  78        # save the resulting commit so we can read-tree on it later
  79        echo "$prev_head" > "$dotest/prev_head"
  80
  81        # onto the next patch:
  82        msgnum=$(($msgnum + 1))
  83        echo "$msgnum" >"$dotest/msgnum"
  84}
  85
  86call_merge () {
  87        cmt="$(cat $dotest/cmt.$1)"
  88        echo "$cmt" > "$dotest/current"
  89        hd=$(git rev-parse --verify HEAD)
  90        cmt_name=$(git symbolic-ref HEAD)
  91        msgnum=$(cat $dotest/msgnum)
  92        end=$(cat $dotest/end)
  93        eval GITHEAD_$cmt='"${cmt_name##refs/heads/}~$(($end - $msgnum))"'
  94        eval GITHEAD_$hd='"$(cat $dotest/onto_name)"'
  95        export GITHEAD_$cmt GITHEAD_$hd
  96        git-merge-$strategy "$cmt^" -- "$hd" "$cmt"
  97        rv=$?
  98        case "$rv" in
  99        0)
 100                unset GITHEAD_$cmt GITHEAD_$hd
 101                return
 102                ;;
 103        1)
 104                git rerere
 105                die "$RESOLVEMSG"
 106                ;;
 107        2)
 108                echo "Strategy: $rv $strategy failed, try another" 1>&2
 109                die "$RESOLVEMSG"
 110                ;;
 111        *)
 112                die "Unknown exit code ($rv) from command:" \
 113                        "git-merge-$strategy $cmt^ -- HEAD $cmt"
 114                ;;
 115        esac
 116}
 117
 118finish_rb_merge () {
 119        rm -r "$dotest"
 120        echo "All done."
 121}
 122
 123is_interactive () {
 124        test -f "$dotest"/interactive ||
 125        while :; do case $#,"$1" in 0,|*,-i|*,--interactive) break ;; esac
 126                shift
 127        done && test -n "$1"
 128}
 129
 130is_interactive "$@" && exec git-rebase--interactive "$@"
 131
 132while test $# != 0
 133do
 134        case "$1" in
 135        --continue)
 136                git diff-files --quiet || {
 137                        echo "You must edit all merge conflicts and then"
 138                        echo "mark them as resolved using git add"
 139                        exit 1
 140                }
 141                if test -d "$dotest"
 142                then
 143                        prev_head="`cat $dotest/prev_head`"
 144                        end="`cat $dotest/end`"
 145                        msgnum="`cat $dotest/msgnum`"
 146                        onto="`cat $dotest/onto`"
 147                        continue_merge
 148                        while test "$msgnum" -le "$end"
 149                        do
 150                                call_merge "$msgnum"
 151                                continue_merge
 152                        done
 153                        finish_rb_merge
 154                        exit
 155                fi
 156                git am --resolved --3way --resolvemsg="$RESOLVEMSG"
 157                exit
 158                ;;
 159        --skip)
 160                if test -d "$dotest"
 161                then
 162                        git rerere clear
 163                        prev_head="`cat $dotest/prev_head`"
 164                        end="`cat $dotest/end`"
 165                        msgnum="`cat $dotest/msgnum`"
 166                        msgnum=$(($msgnum + 1))
 167                        onto="`cat $dotest/onto`"
 168                        while test "$msgnum" -le "$end"
 169                        do
 170                                call_merge "$msgnum"
 171                                continue_merge
 172                        done
 173                        finish_rb_merge
 174                        exit
 175                fi
 176                git am -3 --skip --resolvemsg="$RESOLVEMSG"
 177                exit
 178                ;;
 179        --abort)
 180                git rerere clear
 181                if test -d "$dotest"
 182                then
 183                        rm -r "$dotest"
 184                elif test -d .dotest
 185                then
 186                        rm -r .dotest
 187                else
 188                        die "No rebase in progress?"
 189                fi
 190                git reset --hard ORIG_HEAD
 191                exit
 192                ;;
 193        --onto)
 194                test 2 -le "$#" || usage
 195                newbase="$2"
 196                shift
 197                ;;
 198        -M|-m|--m|--me|--mer|--merg|--merge)
 199                do_merge=t
 200                ;;
 201        -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
 202                --strateg=*|--strategy=*|\
 203        -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
 204                case "$#,$1" in
 205                *,*=*)
 206                        strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
 207                1,*)
 208                        usage ;;
 209                *)
 210                        strategy="$2"
 211                        shift ;;
 212                esac
 213                do_merge=t
 214                ;;
 215        -v|--verbose)
 216                verbose=t
 217                ;;
 218        -C*)
 219                git_am_opt=$1
 220                shift
 221                ;;
 222        -*)
 223                usage
 224                ;;
 225        *)
 226                break
 227                ;;
 228        esac
 229        shift
 230done
 231
 232# Make sure we do not have .dotest
 233if test -z "$do_merge"
 234then
 235        if mkdir .dotest
 236        then
 237                rmdir .dotest
 238        else
 239                echo >&2 '
 240It seems that I cannot create a .dotest directory, and I wonder if you
 241are in the middle of patch application or another rebase.  If that is not
 242the case, please rm -fr .dotest and run me again.  I am stopping in case
 243you still have something valuable there.'
 244                exit 1
 245        fi
 246else
 247        if test -d "$dotest"
 248        then
 249                die "previous dotest directory $dotest still exists." \
 250                        'try git-rebase < --continue | --abort >'
 251        fi
 252fi
 253
 254# The tree must be really really clean.
 255git update-index --refresh || exit
 256diff=$(git diff-index --cached --name-status -r HEAD)
 257case "$diff" in
 258?*)     echo "cannot rebase: your index is not up-to-date"
 259        echo "$diff"
 260        exit 1
 261        ;;
 262esac
 263
 264# The upstream head must be given.  Make sure it is valid.
 265upstream_name="$1"
 266upstream=`git rev-parse --verify "${upstream_name}^0"` ||
 267    die "invalid upstream $upstream_name"
 268
 269# Make sure the branch to rebase onto is valid.
 270onto_name=${newbase-"$upstream_name"}
 271onto=$(git rev-parse --verify "${onto_name}^0") || exit
 272
 273# If a hook exists, give it a chance to interrupt
 274if test -x "$GIT_DIR/hooks/pre-rebase"
 275then
 276        "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
 277                echo >&2 "The pre-rebase hook refused to rebase."
 278                exit 1
 279        }
 280fi
 281
 282# If the branch to rebase is given, first switch to it.
 283case "$#" in
 2842)
 285        branch_name="$2"
 286        git-checkout "$2" || usage
 287        ;;
 288*)
 289        if branch_name=`git symbolic-ref -q HEAD`
 290        then
 291                branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
 292        else
 293                branch_name=HEAD ;# detached
 294        fi
 295        ;;
 296esac
 297branch=$(git rev-parse --verify "${branch_name}^0") || exit
 298
 299# Now we are rebasing commits $upstream..$branch on top of $onto
 300
 301# Check if we are already based on $onto with linear history,
 302# but this should be done only when upstream and onto are the same.
 303mb=$(git merge-base "$onto" "$branch")
 304if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
 305        # linear history?
 306        ! git rev-list --parents "$onto".."$branch" | grep " .* " > /dev/null
 307then
 308        echo >&2 "Current branch $branch_name is up to date."
 309        exit 0
 310fi
 311
 312if test -n "$verbose"
 313then
 314        echo "Changes from $mb to $onto:"
 315        # We want color (if set), but no pager
 316        GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
 317fi
 318
 319# Rewind the head to "$onto"; this saves our current head in ORIG_HEAD.
 320echo "First, rewinding head to replay your work on top of it..."
 321git-reset --hard "$onto"
 322
 323# If the $onto is a proper descendant of the tip of the branch, then
 324# we just fast forwarded.
 325if test "$mb" = "$branch"
 326then
 327        echo >&2 "Fast-forwarded $branch_name to $onto_name."
 328        exit 0
 329fi
 330
 331if test -z "$do_merge"
 332then
 333        git format-patch -k --stdout --full-index --ignore-if-in-upstream "$upstream"..ORIG_HEAD |
 334        git am $git_am_opt --binary -3 -k --resolvemsg="$RESOLVEMSG"
 335        exit $?
 336fi
 337
 338# start doing a rebase with git-merge
 339# this is rename-aware if the recursive (default) strategy is used
 340
 341mkdir -p "$dotest"
 342echo "$onto" > "$dotest/onto"
 343echo "$onto_name" > "$dotest/onto_name"
 344prev_head=`git rev-parse HEAD^0`
 345echo "$prev_head" > "$dotest/prev_head"
 346
 347msgnum=0
 348for cmt in `git rev-list --reverse --no-merges "$upstream"..ORIG_HEAD`
 349do
 350        msgnum=$(($msgnum + 1))
 351        echo "$cmt" > "$dotest/cmt.$msgnum"
 352done
 353
 354echo 1 >"$dotest/msgnum"
 355echo $msgnum >"$dotest/end"
 356
 357end=$msgnum
 358msgnum=1
 359
 360while test "$msgnum" -le "$end"
 361do
 362        call_merge "$msgnum"
 363        continue_merge
 364done
 365
 366finish_rb_merge