]> git.ipfire.org Git - thirdparty/git.git/blame - git-rebase.sh
diff: chapter and part in funcname for tex
[thirdparty/git.git] / git-rebase.sh
CommitLineData
59e6b23a
JH
1#!/bin/sh
2#
3# Copyright (c) 2005 Junio C Hamano.
4#
5
1b1dce4b 6USAGE='[--interactive | -i] [-v] [--onto <newbase>] <upstream> [<branch>]'
031321c6
SE
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.
69a60af5 12
031321c6
SE
13It is possible that a merge failure will prevent this process from being
14completely automatic. You will have to resolve any such merge failure
cc120056
SE
15and run git rebase --continue. Another option is to bypass the commit
16that caused the merge failure with git rebase --skip. To restore the
51ef1daa
JS
17original <branch> and remove the .git/rebase-apply working files, use the
18command git rebase --abort instead.
69a60af5 19
031321c6 20Note that if <branch> is not specified on the command line, the
702088af 21currently checked out branch is used.
e646c9c8 22
031321c6 23Example: git-rebase master~1 topic
e646c9c8 24
031321c6
SE
25 A---B---C topic A'\''--B'\''--C'\'' topic
26 / --> /
27 D---E---F---G master D---E---F---G master
e646c9c8 28'
533b7039
JH
29
30SUBDIRECTORY_OK=Yes
8f321a39 31OPTIONS_SPEC=
ae2b0f15 32. git-sh-setup
f9474132 33set_reflog_action rebase
7eff28a9 34require_work_tree
533b7039 35cd_to_toplevel
4282c4fb 36
cc120056
SE
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"
e646c9c8 42unset newbase
a06f678e 43strategy=recursive
58634dbf 44do_merge=
28ed6e7b 45dotest="$GIT_DIR"/rebase-merge
58634dbf 46prec=4
b758789c 47verbose=
67dad687 48git_am_opt=
58634dbf
EW
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
5be60078 54 unmerged=$(git ls-files -u)
58634dbf
EW
55 if test -n "$unmerged"
56 then
57 echo "You still have unmerged paths in your index"
9b07873a 58 echo "did you forget to use git add?"
66eb64cb 59 die "$RESOLVEMSG"
58634dbf
EW
60 fi
61
889a50e9 62 cmt=`cat "$dotest/current"`
6848d58c 63 if ! git diff-index --quiet --ignore-submodules HEAD --
58634dbf 64 then
e637122e 65 if ! git commit --no-verify -C "$cmt"
f0ef0596
EW
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
7afa845e 71 printf "Committed: %0${prec}d " $msgnum
58634dbf 72 else
7afa845e 73 printf "Already applied: %0${prec}d " $msgnum
58634dbf 74 fi
c7965afd 75 git rev-list --pretty=oneline -1 "$cmt" | sed -e 's/^[^ ]* //'
58634dbf 76
5be60078 77 prev_head=`git rev-parse HEAD^0`
58634dbf 78 # save the resulting commit so we can read-tree on it later
58634dbf
EW
79 echo "$prev_head" > "$dotest/prev_head"
80
81 # onto the next patch:
82 msgnum=$(($msgnum + 1))
5887ac82 83 echo "$msgnum" >"$dotest/msgnum"
58634dbf
EW
84}
85
86call_merge () {
889a50e9 87 cmt="$(cat "$dotest/cmt.$1")"
58634dbf 88 echo "$cmt" > "$dotest/current"
5be60078 89 hd=$(git rev-parse --verify HEAD)
6fd2f5e6 90 cmt_name=$(git symbolic-ref HEAD 2> /dev/null || echo HEAD)
889a50e9
JS
91 msgnum=$(cat "$dotest/msgnum")
92 end=$(cat "$dotest/end")
0bb733c9 93 eval GITHEAD_$cmt='"${cmt_name##refs/heads/}~$(($end - $msgnum))"'
889a50e9 94 eval GITHEAD_$hd='$(cat "$dotest/onto_name")'
0bb733c9
SP
95 export GITHEAD_$cmt GITHEAD_$hd
96 git-merge-$strategy "$cmt^" -- "$hd" "$cmt"
58634dbf
EW
97 rv=$?
98 case "$rv" in
99 0)
0bb733c9 100 unset GITHEAD_$cmt GITHEAD_$hd
9e4bc7dd 101 return
58634dbf
EW
102 ;;
103 1)
b4372ef1 104 git rerere
66eb64cb 105 die "$RESOLVEMSG"
58634dbf
EW
106 ;;
107 2)
108 echo "Strategy: $rv $strategy failed, try another" 1>&2
66eb64cb 109 die "$RESOLVEMSG"
58634dbf
EW
110 ;;
111 *)
112 die "Unknown exit code ($rv) from command:" \
113 "git-merge-$strategy $cmt^ -- HEAD $cmt"
114 ;;
115 esac
116}
117
6fd2f5e6
JS
118move_to_original_branch () {
119 test -z "$head_name" &&
120 head_name="$(cat "$dotest"/head-name)" &&
121 onto="$(cat "$dotest"/onto)" &&
122 orig_head="$(cat "$dotest"/orig-head)"
123 case "$head_name" in
124 refs/*)
125 message="rebase finished: $head_name onto $onto"
126 git update-ref -m "$message" \
127 $head_name $(git rev-parse HEAD) $orig_head &&
128 git symbolic-ref HEAD $head_name ||
129 die "Could not move back to $head_name"
130 ;;
131 esac
132}
133
58634dbf 134finish_rb_merge () {
6fd2f5e6 135 move_to_original_branch
58634dbf
EW
136 rm -r "$dotest"
137 echo "All done."
138}
139
1b1dce4b
JS
140is_interactive () {
141 test -f "$dotest"/interactive ||
822f7c73 142 while :; do case $#,"$1" in 0,|*,-i|*,--interactive) break ;; esac
1b1dce4b
JS
143 shift
144 done && test -n "$1"
145}
146
147is_interactive "$@" && exec git-rebase--interactive "$@"
148
822f7c73 149while test $# != 0
e646c9c8
JH
150do
151 case "$1" in
031321c6 152 --continue)
51ef1daa 153 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
cd5320f2
SB
154 die "No rebase in progress?"
155
6848d58c 156 git diff-files --quiet --ignore-submodules || {
06aff47b 157 echo "You must edit all merge conflicts and then"
9b07873a 158 echo "mark them as resolved using git add"
031321c6 159 exit 1
06aff47b 160 }
58634dbf
EW
161 if test -d "$dotest"
162 then
889a50e9
JS
163 prev_head=$(cat "$dotest/prev_head")
164 end=$(cat "$dotest/end")
165 msgnum=$(cat "$dotest/msgnum")
166 onto=$(cat "$dotest/onto")
58634dbf
EW
167 continue_merge
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
51ef1daa
JS
176 head_name=$(cat "$GIT_DIR"/rebase-apply/head-name) &&
177 onto=$(cat "$GIT_DIR"/rebase-apply/onto) &&
178 orig_head=$(cat "$GIT_DIR"/rebase-apply/orig-head) &&
3f735b66
JS
179 git am --resolved --3way --resolvemsg="$RESOLVEMSG" &&
180 move_to_original_branch
cc120056
SE
181 exit
182 ;;
183 --skip)
51ef1daa 184 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
cd5320f2
SB
185 die "No rebase in progress?"
186
fb6e4e1f 187 git reset --hard HEAD || exit $?
58634dbf
EW
188 if test -d "$dotest"
189 then
b4372ef1 190 git rerere clear
889a50e9
JS
191 prev_head=$(cat "$dotest/prev_head")
192 end=$(cat "$dotest/end")
193 msgnum=$(cat "$dotest/msgnum")
d5e673b6 194 msgnum=$(($msgnum + 1))
889a50e9 195 onto=$(cat "$dotest/onto")
d5e673b6
EW
196 while test "$msgnum" -le "$end"
197 do
198 call_merge "$msgnum"
199 continue_merge
200 done
201 finish_rb_merge
202 exit
58634dbf 203 fi
51ef1daa
JS
204 head_name=$(cat "$GIT_DIR"/rebase-apply/head-name) &&
205 onto=$(cat "$GIT_DIR"/rebase-apply/onto) &&
206 orig_head=$(cat "$GIT_DIR"/rebase-apply/orig-head) &&
6fd2f5e6
JS
207 git am -3 --skip --resolvemsg="$RESOLVEMSG" &&
208 move_to_original_branch
031321c6
SE
209 exit
210 ;;
211 --abort)
51ef1daa 212 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
cd5320f2
SB
213 die "No rebase in progress?"
214
b4372ef1 215 git rerere clear
58634dbf
EW
216 if test -d "$dotest"
217 then
6fd2f5e6 218 move_to_original_branch
cd5320f2 219 else
51ef1daa 220 dotest="$GIT_DIR"/rebase-apply
6fd2f5e6 221 move_to_original_branch
58634dbf 222 fi
97b88dd5 223 git reset --hard $(cat "$dotest/orig-head")
48411d22 224 rm -r "$dotest"
031321c6
SE
225 exit
226 ;;
e646c9c8
JH
227 --onto)
228 test 2 -le "$#" || usage
229 newbase="$2"
230 shift
231 ;;
58634dbf
EW
232 -M|-m|--m|--me|--mer|--merg|--merge)
233 do_merge=t
234 ;;
235 -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
236 --strateg=*|--strategy=*|\
237 -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
238 case "$#,$1" in
239 *,*=*)
8096fae7 240 strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
58634dbf
EW
241 1,*)
242 usage ;;
243 *)
244 strategy="$2"
245 shift ;;
246 esac
247 do_merge=t
248 ;;
b758789c
RS
249 -v|--verbose)
250 verbose=t
251 ;;
059f446d
BF
252 --whitespace=*)
253 git_am_opt="$git_am_opt $1"
254 ;;
67dad687 255 -C*)
059f446d 256 git_am_opt="$git_am_opt $1"
67dad687 257 ;;
e646c9c8
JH
258 -*)
259 usage
260 ;;
261 *)
262 break
263 ;;
264 esac
265 shift
266done
2db8aaec 267
51ef1daa 268# Make sure we do not have $GIT_DIR/rebase-apply
58634dbf 269if test -z "$do_merge"
7f4bd5d8 270then
51ef1daa 271 if mkdir "$GIT_DIR"/rebase-apply
58634dbf 272 then
51ef1daa 273 rmdir "$GIT_DIR"/rebase-apply
58634dbf
EW
274 else
275 echo >&2 '
51ef1daa
JS
276It seems that I cannot create a '"$GIT_DIR"'/rebase-apply directory,
277and I wonder if you are in the middle of patch application or another
278rebase. If that is not the case, please
279 rm -fr '"$GIT_DIR"'/rebase-apply
280 and run me again. I am stopping in case you still have something
281valuable there.'
58634dbf
EW
282 exit 1
283 fi
284else
285 if test -d "$dotest"
286 then
28ed6e7b 287 die "previous rebase directory $dotest still exists." \
58634dbf
EW
288 'try git-rebase < --continue | --abort >'
289 fi
7f4bd5d8
JH
290fi
291
7f59dbbb 292# The tree must be really really clean.
6848d58c
JS
293git update-index --ignore-submodules --refresh || exit
294diff=$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)
32d99544 295case "$diff" in
6e598c32
DK
296?*) echo "cannot rebase: your index is not up-to-date"
297 echo "$diff"
7f59dbbb
JH
298 exit 1
299 ;;
300esac
99a92f92 301
e646c9c8
JH
302# The upstream head must be given. Make sure it is valid.
303upstream_name="$1"
304upstream=`git rev-parse --verify "${upstream_name}^0"` ||
d0080b3c 305 die "invalid upstream $upstream_name"
32d99544 306
a1bf91e0
JH
307# Make sure the branch to rebase onto is valid.
308onto_name=${newbase-"$upstream_name"}
5be60078 309onto=$(git rev-parse --verify "${onto_name}^0") || exit
a1bf91e0 310
9a111c91
JH
311# If a hook exists, give it a chance to interrupt
312if test -x "$GIT_DIR/hooks/pre-rebase"
313then
314 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
315 echo >&2 "The pre-rebase hook refused to rebase."
316 exit 1
317 }
318fi
319
0cb06644
JH
320# If the branch to rebase is given, that is the branch we will rebase
321# $branch_name -- branch being rebased, or HEAD (already detached)
322# $orig_head -- commit object name of tip of the branch before rebasing
323# $head_name -- refs/heads/<that-branch> or "detached HEAD"
324switch_to=
59e6b23a 325case "$#" in
7f59dbbb 3262)
0cb06644 327 # Is it "rebase other $branchname" or "rebase other $commit"?
e646c9c8 328 branch_name="$2"
0cb06644
JH
329 switch_to="$2"
330
331 if git show-ref --verify --quiet -- "refs/heads/$2" &&
332 branch=$(git rev-parse --verify "refs/heads/$2" 2>/dev/null)
333 then
334 head_name="refs/heads/$2"
335 elif branch=$(git rev-parse --verify "$2" 2>/dev/null)
336 then
337 head_name="detached HEAD"
338 else
339 usage
340 fi
e646c9c8
JH
341 ;;
342*)
0cb06644 343 # Do not need to switch branches, we are already on it.
bcf31618
JH
344 if branch_name=`git symbolic-ref -q HEAD`
345 then
0cb06644 346 head_name=$branch_name
bcf31618
JH
347 branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
348 else
0cb06644 349 head_name="detached HEAD"
bcf31618
JH
350 branch_name=HEAD ;# detached
351 fi
0cb06644 352 branch=$(git rev-parse --verify "${branch_name}^0") || exit
e646c9c8 353 ;;
59e6b23a 354esac
0cb06644 355orig_head=$branch
59e6b23a 356
e646c9c8
JH
357# Now we are rebasing commits $upstream..$branch on top of $onto
358
1308c17b
JS
359# Check if we are already based on $onto with linear history,
360# but this should be done only when upstream and onto are the same.
5be60078 361mb=$(git merge-base "$onto" "$branch")
1308c17b
JS
362if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
363 # linear history?
bbf08124 364 ! (git rev-list --parents "$onto".."$branch" | grep " .* ") > /dev/null
7f4bd5d8 365then
0cb06644
JH
366 # Lazily switch to the target branch if needed...
367 test -z "$switch_to" || git checkout "$switch_to"
83c31614
RS
368 echo >&2 "Current branch $branch_name is up to date."
369 exit 0
7f4bd5d8
JH
370fi
371
b758789c
RS
372if test -n "$verbose"
373then
374 echo "Changes from $mb to $onto:"
fefe49d1 375 # We want color (if set), but no pager
5be60078 376 GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
b758789c
RS
377fi
378
0cb06644 379# Detach HEAD and reset the tree
228e2eb6 380echo "First, rewinding head to replay your work on top of it..."
324c2c31 381git checkout -q "$onto^0" || die "could not detach HEAD"
22e40795 382git update-ref ORIG_HEAD $branch
32d99544 383
e646c9c8 384# If the $onto is a proper descendant of the tip of the branch, then
32d99544 385# we just fast forwarded.
83c31614 386if test "$mb" = "$branch"
32d99544 387then
d587ed13 388 echo >&2 "Fast-forwarded $branch_name to $onto_name."
6fd2f5e6 389 move_to_original_branch
32d99544
LS
390 exit 0
391fi
392
58634dbf
EW
393if test -z "$do_merge"
394then
0cb06644
JH
395 git format-patch -k --stdout --full-index --ignore-if-in-upstream \
396 "$upstream..$orig_head" |
3041c324 397 git am $git_am_opt --rebasing --resolvemsg="$RESOLVEMSG" &&
6fd2f5e6
JS
398 move_to_original_branch
399 ret=$?
51ef1daa
JS
400 test 0 != $ret -a -d "$GIT_DIR"/rebase-apply &&
401 echo $head_name > "$GIT_DIR"/rebase-apply/head-name &&
402 echo $onto > "$GIT_DIR"/rebase-apply/onto &&
403 echo $orig_head > "$GIT_DIR"/rebase-apply/orig-head
6fd2f5e6 404 exit $ret
58634dbf
EW
405fi
406
407# start doing a rebase with git-merge
408# this is rename-aware if the recursive (default) strategy is used
409
410mkdir -p "$dotest"
411echo "$onto" > "$dotest/onto"
0bb733c9 412echo "$onto_name" > "$dotest/onto_name"
6fd2f5e6 413prev_head=$orig_head
58634dbf 414echo "$prev_head" > "$dotest/prev_head"
6fd2f5e6
JS
415echo "$orig_head" > "$dotest/orig-head"
416echo "$head_name" > "$dotest/head-name"
58634dbf
EW
417
418msgnum=0
0cb06644 419for cmt in `git rev-list --reverse --no-merges "$upstream..$orig_head"`
58634dbf
EW
420do
421 msgnum=$(($msgnum + 1))
5887ac82 422 echo "$cmt" > "$dotest/cmt.$msgnum"
58634dbf
EW
423done
424
5887ac82
JH
425echo 1 >"$dotest/msgnum"
426echo $msgnum >"$dotest/end"
58634dbf
EW
427
428end=$msgnum
429msgnum=1
430
431while test "$msgnum" -le "$end"
432do
433 call_merge "$msgnum"
434 continue_merge
435done
cc120056 436
58634dbf 437finish_rb_merge