Improved pack format documentation.
[git] / git-rebase.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2005 Junio C Hamano.
4 #
5
6 USAGE='[--onto <newbase>] <upstream> [<branch>]'
7 LONG_USAGE='git-rebase replaces <branch> with a new branch of the
8 same name.  When the --onto option is provided the new branch starts
9 out with a HEAD equal to <newbase>, otherwise it is equal to <upstream>
10 It then attempts to create a new commit for each commit from the original
11 <branch> that does not exist in the <upstream> branch.
12
13 It is possible that a merge failure will prevent this process from being
14 completely automatic.  You will have to resolve any such merge failure
15 and run git rebase --continue.  Another option is to bypass the commit
16 that caused the merge failure with git rebase --skip.  To restore the
17 original <branch> and remove the .dotest working files, use the command
18 git rebase --abort instead.
19
20 Note that if <branch> is not specified on the command line, the
21 currently checked out branch is used.  You must be in the top
22 directory of your project to start (or continue) a rebase.
23
24 Example:       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 . git-sh-setup
31
32 RESOLVEMSG="
33 When you have resolved this problem run \"git rebase --continue\".
34 If you would prefer to skip this patch, instead run \"git rebase --skip\".
35 To restore the original branch and stop rebasing run \"git rebase --abort\".
36 "
37 unset newbase
38 while case "$#" in 0) break ;; esac
39 do
40         case "$1" in
41         --continue)
42                 diff=$(git-diff-files)
43                 case "$diff" in
44                 ?*)     echo "You must edit all merge conflicts and then"
45                         echo "mark them as resolved using git update-index"
46                         exit 1
47                         ;;
48                 esac
49                 git am --resolved --3way --resolvemsg="$RESOLVEMSG"
50                 exit
51                 ;;
52         --skip)
53                 git am -3 --skip --resolvemsg="$RESOLVEMSG"
54                 exit
55                 ;;
56         --abort)
57                 [ -d .dotest ] || die "No rebase in progress?"
58                 git reset --hard ORIG_HEAD
59                 rm -r .dotest
60                 exit
61                 ;;
62         --onto)
63                 test 2 -le "$#" || usage
64                 newbase="$2"
65                 shift
66                 ;;
67         -*)
68                 usage
69                 ;;
70         *)
71                 break
72                 ;;
73         esac
74         shift
75 done
76
77 # Make sure we do not have .dotest
78 if mkdir .dotest
79 then
80         rmdir .dotest
81 else
82         echo >&2 '
83 It seems that I cannot create a .dotest directory, and I wonder if you
84 are in the middle of patch application or another rebase.  If that is not
85 the case, please rm -fr .dotest and run me again.  I am stopping in case
86 you still have something valuable there.'
87         exit 1
88 fi
89
90 # The tree must be really really clean.
91 git-update-index --refresh || exit
92 diff=$(git-diff-index --cached --name-status -r HEAD)
93 case "$diff" in
94 ?*)     echo "$diff"
95         exit 1
96         ;;
97 esac
98
99 # The upstream head must be given.  Make sure it is valid.
100 upstream_name="$1"
101 upstream=`git rev-parse --verify "${upstream_name}^0"` ||
102     die "invalid upstream $upstream_name"
103
104 # If a hook exists, give it a chance to interrupt
105 if test -x "$GIT_DIR/hooks/pre-rebase"
106 then
107         "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
108                 echo >&2 "The pre-rebase hook refused to rebase."
109                 exit 1
110         }
111 fi
112
113 # If the branch to rebase is given, first switch to it.
114 case "$#" in
115 2)
116         branch_name="$2"
117         git-checkout "$2" || usage
118         ;;
119 *)
120         branch_name=`git symbolic-ref HEAD` || die "No current branch"
121         branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
122         ;;
123 esac
124 branch=$(git-rev-parse --verify "${branch_name}^0") || exit
125
126 # Make sure the branch to rebase onto is valid.
127 onto_name=${newbase-"$upstream_name"}
128 onto=$(git-rev-parse --verify "${onto_name}^0") || exit
129
130 # Now we are rebasing commits $upstream..$branch on top of $onto
131
132 # Check if we are already based on $onto, but this should be
133 # done only when upstream and onto are the same.
134 if test "$upstream" = "$onto"
135 then
136         mb=$(git-merge-base "$onto" "$branch")
137         if test "$mb" = "$onto"
138         then
139                 echo >&2 "Current branch $branch_name is up to date."
140                 exit 0
141         fi
142 fi
143
144 # Rewind the head to "$onto"; this saves our current head in ORIG_HEAD.
145 git-reset --hard "$onto"
146
147 # If the $onto is a proper descendant of the tip of the branch, then
148 # we just fast forwarded.
149 if test "$mb" = "$onto"
150 then
151         echo >&2 "Fast-forwarded $branch to $newbase."
152         exit 0
153 fi
154
155 git-format-patch -k --stdout --full-index "$upstream"..ORIG_HEAD |
156 git am --binary -3 -k --resolvemsg="$RESOLVEMSG"
157