3 # Copyright (c) 2005 Junio C Hamano.
6 USAGE='[--interactive | -i] [--exec | -x <cmd>] [-v] [--force-rebase | -f]
7 [--no-ff] [--onto <newbase>] [<upstream>|--root] [<branch>] [--quiet | -q]'
8 LONG_USAGE='git-rebase replaces <branch> with a new branch of the
9 same name. When the --onto option is provided the new branch starts
10 out with a HEAD equal to <newbase>, otherwise it is equal to <upstream>
11 It then attempts to create a new commit for each commit from the original
12 <branch> that does not exist in the <upstream> branch.
14 It is possible that a merge failure will prevent this process from being
15 completely automatic. You will have to resolve any such merge failure
16 and run git rebase --continue. Another option is to bypass the commit
17 that caused the merge failure with git rebase --skip. To check out the
18 original <branch> and remove the .git/rebase-apply working files, use the
19 command git rebase --abort instead.
21 Note that if <branch> is not specified on the command line, the
22 currently checked out branch is used.
24 Example: git-rebase master~1 topic
26 A---B---C topic A'\''--B'\''--C'\'' topic
28 D---E---F---G master D---E---F---G master
34 git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] [<upstream>] [<branch>]
35 git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] --root [<branch>]
36 git-rebase [-i] --continue | --abort | --skip
39 v,verbose! display a diffstat of what changed upstream
40 q,quiet! be quiet. implies --no-stat
41 onto=! rebase onto given branch instead of upstream
42 p,preserve-merges! try to recreate merges instead of ignoring them
43 s,strategy=! use the given merge strategy
44 no-ff! cherry-pick all commits, even if unchanged
45 m,merge! use merging strategies to rebase
46 i,interactive! let the user edit the list of commits to rebase
47 x,exec=! add exec lines after each commit of the editable list
48 k,keep-empty preserve empty commits during rebase
49 f,force-rebase! force rebase even if branch is up to date
50 X,strategy-option=! pass the argument through to the merge strategy
51 stat! display a diffstat of what changed upstream
52 n,no-stat! do not show diffstat of what changed upstream
53 verify allow pre-rebase hook to run
54 rerere-autoupdate allow rerere to update index with resolved conflicts
55 root! rebase all reachable commits up to the root(s)
56 autosquash move commits that begin with squash!/fixup! under -i
57 committer-date-is-author-date! passed to 'git am'
58 ignore-date! passed to 'git am'
59 whitespace=! passed to 'git apply'
60 ignore-whitespace! passed to 'git apply'
61 C=! passed to 'git apply'
64 abort! abort and check out the original branch
65 skip! skip current patch and continue
69 set_reflog_action rebase
70 require_work_tree_exists
75 ok_to_skip_pre_rebase=
77 $(gettext 'When you have resolved this problem, run "git rebase --continue".
78 If you prefer to skip this patch, run "git rebase --skip" instead.
79 To check out the original branch and stop rebasing, run "git rebase --abort".')
86 merge_dir="$GIT_DIR"/rebase-merge
87 apply_dir="$GIT_DIR"/rebase-apply
90 test "$(git config --bool rebase.stat)" = true && diffstat=t
94 allow_rerere_autoupdate=
95 # Non-empty if a rebase was in progress when 'git rebase' was invoked
97 # One of {am, merge, interactive}
99 # One of {"$GIT_DIR"/rebase-apply, "$GIT_DIR"/rebase-merge}
101 # One of {'', continue, skip, abort}, as parsed from command line
106 test "$(git config --bool rebase.autosquash)" = "true" && autosquash=t
108 read_basic_state () {
109 head_name=$(cat "$state_dir"/head-name) &&
110 onto=$(cat "$state_dir"/onto) &&
111 # We always write to orig-head, but interactive rebase used to write to
112 # head. Fall back to reading from head to cover for the case that the
113 # user upgraded git with an ongoing interactive rebase.
114 if test -f "$state_dir"/orig-head
116 orig_head=$(cat "$state_dir"/orig-head)
118 orig_head=$(cat "$state_dir"/head)
120 GIT_QUIET=$(cat "$state_dir"/quiet) &&
121 test -f "$state_dir"/verbose && verbose=t
122 test -f "$state_dir"/strategy && strategy="$(cat "$state_dir"/strategy)"
123 test -f "$state_dir"/strategy_opts &&
124 strategy_opts="$(cat "$state_dir"/strategy_opts)"
125 test -f "$state_dir"/allow_rerere_autoupdate &&
126 allow_rerere_autoupdate="$(cat "$state_dir"/allow_rerere_autoupdate)"
129 write_basic_state () {
130 echo "$head_name" > "$state_dir"/head-name &&
131 echo "$onto" > "$state_dir"/onto &&
132 echo "$orig_head" > "$state_dir"/orig-head &&
133 echo "$GIT_QUIET" > "$state_dir"/quiet &&
134 test t = "$verbose" && : > "$state_dir"/verbose
135 test -n "$strategy" && echo "$strategy" > "$state_dir"/strategy
136 test -n "$strategy_opts" && echo "$strategy_opts" > \
137 "$state_dir"/strategy_opts
138 test -n "$allow_rerere_autoupdate" && echo "$allow_rerere_autoupdate" > \
139 "$state_dir"/allow_rerere_autoupdate
147 test $status != 0 && printf "%s\n" "$output"
156 move_to_original_branch () {
159 message="rebase finished: $head_name onto $onto"
160 git update-ref -m "$message" \
161 $head_name $(git rev-parse HEAD) $orig_head &&
163 -m "rebase finished: returning to $head_name" \
165 die "$(gettext "Could not move back to $head_name")"
170 run_specific_rebase () {
171 if [ "$interactive_rebase" = implied ]; then
179 run_pre_rebase_hook () {
180 if test -z "$ok_to_skip_pre_rebase" &&
181 test -x "$GIT_DIR/hooks/pre-rebase"
183 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} ||
184 die "$(gettext "The pre-rebase hook refused to rebase.")"
188 test -f "$apply_dir"/applying &&
189 die "$(gettext "It looks like git-am is in progress. Cannot rebase.")"
191 if test -d "$apply_dir"
194 state_dir="$apply_dir"
195 elif test -d "$merge_dir"
197 if test -f "$merge_dir"/interactive
200 interactive_rebase=explicit
204 state_dir="$merge_dir"
206 test -n "$type" && in_progress=t
213 ok_to_skip_pre_rebase=yes
216 ok_to_skip_pre_rebase=
218 --continue|--skip|--abort)
219 test $total_argc -eq 2 || usage
223 test 2 -le "$#" || usage
228 test 2 -le "$#" || usage
229 cmd="${cmd}exec $2${LF}"
233 interactive_rebase=explicit
240 test -z "$interactive_rebase" && interactive_rebase=implied
253 strategy_opts="$strategy_opts $(git rev-parse --sq-quote "--$1")"
255 test -z "$strategy" && strategy=recursive
275 git_am_opt="$git_am_opt -q"
281 git_am_opt="$git_am_opt --whitespace=$1"
289 git_am_opt="$git_am_opt $1"
291 --committer-date-is-author-date|--ignore-date)
292 git_am_opt="$git_am_opt $1"
297 git_am_opt="$git_am_opt -C$1"
305 --rerere-autoupdate|--no-rerere-autoupdate)
306 allow_rerere_autoupdate="$1"
315 test $# -gt 2 && usage
318 test "$interactive_rebase" != explicit
320 die "$(gettext -- "--exec option must be used with --interactive option")"
325 test -z "$in_progress" && die "$(gettext "No rebase in progress?")"
326 # Only interactive rebase uses detailed reflog messages
327 if test "$type" = interactive && test "$GIT_REFLOG_ACTION" = rebase
329 GIT_REFLOG_ACTION="rebase -i ($action)"
330 export GIT_REFLOG_ACTION
337 git rev-parse --verify HEAD >/dev/null ||
338 die "$(gettext "Cannot read HEAD")"
339 git update-index --ignore-submodules --refresh &&
340 git diff-files --quiet --ignore-submodules || {
341 echo "$(gettext "You must edit all merge conflicts and then
342 mark them as resolved using git add")"
349 output git reset --hard HEAD || exit $?
358 git symbolic-ref -m "rebase: aborting" HEAD $head_name ||
359 die "$(eval_gettext "Could not move back to \$head_name")"
362 output git reset --hard $orig_head
368 # Make sure no rebase is in progress
369 if test -n "$in_progress"
371 state_dir_base=${state_dir##*/}
372 cmd_live_rebase="git rebase (--continue | --abort | --skip)"
373 cmd_clear_stale_rebase="rm -fr \"$state_dir\""
375 $(eval_gettext 'It seems that there is already a $state_dir_base directory, and
376 I wonder if you ware in the middle of another rebase. If that is the
379 If that is not the case, please
380 $cmd_clear_stale_rebase
381 and run me again. I am stopping in case you still have something
385 if test -n "$rebase_root" && test -z "$onto"
387 test -z "$interactive_rebase" && interactive_rebase=implied
390 if test -n "$interactive_rebase"
393 state_dir="$merge_dir"
394 elif test -n "$do_merge"
397 state_dir="$merge_dir"
400 state_dir="$apply_dir"
403 if test -z "$rebase_root"
407 if ! upstream_name=$(git rev-parse --symbolic-full-name \
408 --verify -q @{upstream} 2>/dev/null)
411 error_on_missing_default_upstream "rebase" "rebase" \
412 "against" "git rebase <branch>"
415 *) upstream_name="$1"
419 upstream=`git rev-parse --verify "${upstream_name}^0"` ||
420 die "$(eval_gettext "invalid upstream \$upstream_name")"
421 upstream_arg="$upstream_name"
425 empty_tree=`git hash-object -t tree /dev/null`
426 onto=`git commit-tree $empty_tree </dev/null`
431 test $# -gt 1 && usage
435 # Make sure the branch to rebase onto is valid.
436 onto_name=${onto-"$upstream_name"}
439 if left=${onto_name%...*} right=${onto_name#*...} &&
440 onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
444 die "$(eval_gettext "\$onto_name: there are more than one merge bases")"
447 die "$(eval_gettext "\$onto_name: there is no merge base")"
451 die "$(eval_gettext "\$onto_name: there is no merge base")"
455 onto=$(git rev-parse --verify "${onto_name}^0") ||
456 die "$(eval_gettext "Does not point to a valid commit: \$onto_name")"
460 # If the branch to rebase is given, that is the branch we will rebase
461 # $branch_name -- branch being rebased, or HEAD (already detached)
462 # $orig_head -- commit object name of tip of the branch before rebasing
463 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
467 # Is it "rebase other $branchname" or "rebase other $commit"?
471 if git show-ref --verify --quiet -- "refs/heads/$1" &&
472 orig_head=$(git rev-parse -q --verify "refs/heads/$1")
474 head_name="refs/heads/$1"
475 elif orig_head=$(git rev-parse -q --verify "$1")
477 head_name="detached HEAD"
479 die "$(eval_gettext "fatal: no such branch: \$branch_name")"
483 # Do not need to switch branches, we are already on it.
484 if branch_name=`git symbolic-ref -q HEAD`
486 head_name=$branch_name
487 branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
489 head_name="detached HEAD"
490 branch_name=HEAD ;# detached
492 orig_head=$(git rev-parse --verify "${branch_name}^0") || exit
495 die "BUG: unexpected number of arguments left to parse"
499 require_clean_work_tree "rebase" "$(gettext "Please commit or stash them.")"
501 # Now we are rebasing commits $upstream..$orig_head (or with --root,
502 # everything leading up to $orig_head) on top of $onto
504 # Check if we are already based on $onto with linear history,
505 # but this should be done only when upstream and onto are the same
506 # and if this is not an interactive rebase.
507 mb=$(git merge-base "$onto" "$orig_head")
508 if test "$type" != interactive && test "$upstream" = "$onto" &&
509 test "$mb" = "$onto" &&
511 ! (git rev-list --parents "$onto".."$orig_head" | sane_grep " .* ") > /dev/null
513 if test -z "$force_rebase"
515 # Lazily switch to the target branch if needed...
516 test -z "$switch_to" || git checkout "$switch_to" --
517 say "$(eval_gettext "Current branch \$branch_name is up to date.")"
520 say "$(eval_gettext "Current branch \$branch_name is up to date, rebase forced.")"
524 # If a hook exists, give it a chance to interrupt
525 run_pre_rebase_hook "$upstream_arg" "$@"
527 if test -n "$diffstat"
529 if test -n "$verbose"
531 echo "$(eval_gettext "Changes from \$mb to \$onto:")"
533 # We want color (if set), but no pager
534 GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
537 test "$type" = interactive && run_specific_rebase
539 # Detach HEAD and reset the tree
540 say "$(gettext "First, rewinding head to replay your work on top of it...")"
541 git checkout -q "$onto^0" || die "could not detach HEAD"
542 git update-ref ORIG_HEAD $orig_head
544 # If the $onto is a proper descendant of the tip of the branch, then
545 # we just fast-forwarded.
546 if test "$mb" = "$orig_head"
548 say "$(eval_gettext "Fast-forwarded \$branch_name to \$onto_name.")"
549 move_to_original_branch
553 if test -n "$rebase_root"
555 revisions="$onto..$orig_head"
557 revisions="$upstream..$orig_head"