3 # Copyright (c) 2006 Johannes E. Schindelin
7 # This script makes it easy to fix up commits in the middle of a series,
8 # and rearrange commits.
10 # The original idea comes from Eric W. Biederman, in
11 # http://article.gmane.org/gmane.comp.version-control.git/22407
13 USAGE
='(--continue | --abort | --skip | [--preserve-merges] [--verbose]
14 [--onto <branch>] <upstream> [<branch>])'
20 DOTEST
="$GIT_DIR/.dotest-merge"
21 TODO
="$DOTEST"/git-rebase-todo
24 SQUASH_MSG
="$DOTEST"/message-squash
25 REWRITTEN
="$DOTEST"/rewritten
29 test -d "$REWRITTEN" && PRESERVE_MERGES
=t
30 test -f "$DOTEST"/strategy
&& STRATEGY
="$(cat "$DOTEST"/strategy)"
31 test -f "$DOTEST"/verbose
&& VERBOSE
=t
33 GIT_CHERRY_PICK_HELP
=" After resolving the conflicts,
34 mark the corrected paths with 'git add <paths>', and
35 run 'git rebase --continue'"
36 export GIT_CHERRY_PICK_HELP
47 test $status != 0 && printf "%s\n" "$output"
56 require_clean_work_tree
() {
57 # test if working tree is dirty
58 git rev-parse
--verify HEAD
> /dev
/null
&&
59 git update-index
--refresh &&
60 git diff-files
--quiet &&
61 git diff-index
--cached --quiet HEAD
-- ||
62 die
"Working tree is dirty"
65 ORIG_REFLOG_ACTION
="$GIT_REFLOG_ACTION"
67 comment_for_reflog
() {
68 case "$ORIG_REFLOG_ACTION" in
70 GIT_REFLOG_ACTION
="rebase -i ($1)"
71 export GIT_REFLOG_ACTION
77 sed -e 1q
< "$TODO" >> "$DONE"
78 sed -e 1d
< "$TODO" >> "$TODO".new
79 mv -f "$TODO".new
"$TODO"
80 count
=$
(($
(grep -ve '^$' -e '^#' < "$DONE" |
wc -l)))
81 total
=$
(($count+$
(grep -ve '^$' -e '^#' < "$TODO" |
wc -l)))
82 printf "Rebasing (%d/%d)\r" $count $total
83 test -z "$VERBOSE" ||
echo
87 parent_sha1
=$
(git rev-parse
--verify "$1"^
) ||
88 die
"Cannot get patch for $1^"
89 git diff-tree
-p "$parent_sha1"..
"$1" > "$DOTEST"/patch
90 test -f "$DOTEST"/message ||
91 git cat-file commit
"$1" |
sed "1,/^$/d" > "$DOTEST"/message
92 test -f "$DOTEST"/author-script ||
93 get_author_ident_from_commit
"$1" > "$DOTEST"/author-script
107 grep -vqe '^$' -e '^#' "$1"
112 case "$1" in -n) sha1
=$2; no_ff
=t
;; *) sha1
=$1 ;; esac
113 output git rev-parse
--verify $sha1 || die
"Invalid commit name: $sha1"
114 test -d "$REWRITTEN" &&
115 pick_one_preserving_merges
"$@" && return
116 parent_sha1
=$
(git rev-parse
--verify $sha1^
) ||
117 die
"Could not get the parent of $sha1"
118 current_sha1
=$
(git rev-parse
--verify HEAD
)
119 if test "$no_ff$current_sha1" = "$parent_sha1"; then
120 output git
reset --hard $sha1
121 test "a$1" = a-n
&& output git
reset --soft $current_sha1
122 sha1
=$
(git rev-parse
--short $sha1)
123 output warn Fast forward to
$sha1
125 output git cherry-pick
"$@"
129 pick_one_preserving_merges
() {
130 case "$1" in -n) sha1
=$2 ;; *) sha1
=$1 ;; esac
131 sha1
=$
(git rev-parse
$sha1)
133 if test -f "$DOTEST"/current-commit
135 current_commit
=$
(cat "$DOTEST"/current-commit
) &&
136 git rev-parse HEAD
> "$REWRITTEN"/$current_commit &&
137 rm "$DOTEST"/current-commit ||
138 die
"Cannot write current commit's replacement sha1"
141 # rewrite parents; if none were rewritten, we can fast-forward.
145 for p
in $
(git rev-list
--parents -1 $sha1 | cut
-d' ' -f2-)
147 if test -f "$REWRITTEN"/$p
150 new_p
=$
(cat "$REWRITTEN"/$p)
151 test $p != $new_p && fast_forward
=f
152 case "$new_parents" in
154 ;; # do nothing; that parent is already there
156 new_parents
="$new_parents $new_p"
161 case $fast_forward in
163 output warn
"Fast forward to $sha1"
164 test $preserve = f ||
echo $sha1 > "$REWRITTEN"/$sha1
167 test "a$1" = a-n
&& die
"Refusing to squash a merge: $sha1"
169 first_parent
=$
(expr "$new_parents" : ' \([^ ]*\)')
170 # detach HEAD to current parent
171 output git checkout
$first_parent 2> /dev
/null ||
172 die
"Cannot move HEAD to $first_parent"
174 echo $sha1 > "$DOTEST"/current-commit
175 case "$new_parents" in
178 author_script
=$
(get_author_ident_from_commit
$sha1)
179 eval "$author_script"
180 msg
="$(git cat-file commit $sha1 | sed -e '1,/^$/d')"
181 # No point in merging the first parent, that's HEAD
182 new_parents
=${new_parents# $first_parent}
183 # NEEDSWORK: give rerere a chance
184 if ! GIT_AUTHOR_NAME
="$GIT_AUTHOR_NAME" \
185 GIT_AUTHOR_EMAIL
="$GIT_AUTHOR_EMAIL" \
186 GIT_AUTHOR_DATE
="$GIT_AUTHOR_DATE" \
187 output git merge
$STRATEGY -m "$msg" \
190 printf "%s\n" "$msg" > "$GIT_DIR"/MERGE_MSG
191 die Error redoing merge
$sha1
195 output git cherry-pick
"$@" ||
196 die_with_patch
$sha1 "Could not pick $sha1"
205 *1[0-9]|
*[04-9]) echo "$1"th
;;
212 make_squash_message
() {
213 if test -f "$SQUASH_MSG"; then
214 COUNT
=$
(($
(sed -n "s/^# This is [^0-9]*\([1-9][0-9]*\).*/\1/p" \
215 < "$SQUASH_MSG" |
tail -n 1)+1))
216 echo "# This is a combination of $COUNT commits."
217 sed -n "2,\$p" < "$SQUASH_MSG"
220 echo "# This is a combination of two commits."
221 echo "# The first commit's message is:"
223 git cat-file commit HEAD |
sed -e '1,/^$/d'
226 echo "# This is the $(nth_string $COUNT) commit message:"
228 git cat-file commit
$1 |
sed -e '1,/^$/d'
231 peek_next_command
() {
232 sed -n "1s/ .*$//p" < "$TODO"
236 rm -f "$DOTEST"/message
"$DOTEST"/author-script \
237 "$DOTEST"/amend ||
exit
238 read command sha1 rest
< "$TODO"
244 comment_for_reflog pick
248 die_with_patch
$sha1 "Could not apply $sha1... $rest"
251 comment_for_reflog edit
255 die_with_patch
$sha1 "Could not apply $sha1... $rest"
259 warn
"You can amend the commit now, with"
261 warn
" git commit --amend"
266 comment_for_reflog squash
268 has_action
"$DONE" ||
269 die
"Cannot 'squash' without a previous commit"
272 make_squash_message
$sha1 > "$MSG"
273 case "$(peek_next_command)" in
277 cp "$MSG" "$SQUASH_MSG"
282 rm -f "$SQUASH_MSG" ||
exit
287 author_script
=$
(get_author_ident_from_commit HEAD
)
288 output git
reset --soft HEAD^
289 pick_one
-n $sha1 || failed
=t
290 echo "$author_script" > "$DOTEST"/author-script
293 # This is like --amend, but with a different message
294 eval "$author_script"
295 GIT_AUTHOR_NAME
="$GIT_AUTHOR_NAME" \
296 GIT_AUTHOR_EMAIL
="$GIT_AUTHOR_EMAIL" \
297 GIT_AUTHOR_DATE
="$GIT_AUTHOR_DATE" \
298 $USE_OUTPUT git commit
-F "$MSG" $EDIT_COMMIT
301 cp "$MSG" "$GIT_DIR"/MERGE_MSG
303 warn
"Could not apply $sha1... $rest"
304 die_with_patch
$sha1 ""
309 warn
"Unknown command: $command $sha1 $rest"
310 die_with_patch
$sha1 "Please fix this in the file $TODO."
313 test -s "$TODO" && return
315 comment_for_reflog finish
&&
316 HEADNAME
=$
(cat "$DOTEST"/head-name
) &&
317 OLDHEAD
=$
(cat "$DOTEST"/head) &&
318 SHORTONTO
=$
(git rev-parse
--short $
(cat "$DOTEST"/onto
)) &&
319 if test -d "$REWRITTEN"
321 test -f "$DOTEST"/current-commit
&&
322 current_commit
=$
(cat "$DOTEST"/current-commit
) &&
323 git rev-parse HEAD
> "$REWRITTEN"/$current_commit
324 NEWHEAD
=$
(cat "$REWRITTEN"/$OLDHEAD)
326 NEWHEAD
=$
(git rev-parse HEAD
)
330 message
="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO)" &&
331 git update-ref
-m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
332 git symbolic-ref HEAD
$HEADNAME
335 test ! -f "$DOTEST"/verbose ||
336 git diff-tree
--stat $
(cat "$DOTEST"/head)..HEAD
340 warn
"Successfully rebased and updated $HEADNAME."
356 comment_for_reflog
continue
358 test -d "$DOTEST" || die
"No interactive rebase running"
360 # commit if necessary
361 git rev-parse
--verify HEAD
> /dev
/null
&&
362 git update-index
--refresh &&
363 git diff-files
--quiet &&
364 ! git diff-index
--cached --quiet HEAD
-- &&
365 .
"$DOTEST"/author-script
&& {
366 test ! -f "$DOTEST"/amend || git
reset --soft HEAD^
368 export GIT_AUTHOR_NAME GIT_AUTHOR_NAME GIT_AUTHOR_DATE
&&
369 git commit
-F "$DOTEST"/message
-e
371 require_clean_work_tree
375 comment_for_reflog abort
377 test -d "$DOTEST" || die
"No interactive rebase running"
379 HEADNAME
=$
(cat "$DOTEST"/head-name
)
380 HEAD
=$
(cat "$DOTEST"/head)
383 git symbolic-ref HEAD
$HEADNAME
386 output git
reset --hard $HEAD &&
391 comment_for_reflog skip
393 test -d "$DOTEST" || die
"No interactive rebase running"
395 output git
reset --hard && do_rest
400 STRATEGY
="-s "$
(expr "z$1" : 'z-[^=]*=\(.*\)') ;;
409 # we use merge anyway
412 die
"Interactive rebase uses merge, so $1 does not make sense"
417 -p|
--preserve-merges)
428 die
"Interactive rebase already started"
430 git var GIT_COMMITTER_IDENT
>/dev
/null ||
431 die
"You need to set your committer info first"
433 comment_for_reflog start
438 ONTO
=$
(git rev-parse
--verify "$2") ||
439 die
"Does not point to a valid commit: $2"
444 require_clean_work_tree
448 output git show-ref
--verify --quiet "refs/heads/$2" ||
449 die
"Invalid branchname: $2"
450 output git checkout
"$2" ||
451 die
"Could not checkout $2"
454 HEAD
=$
(git rev-parse
--verify HEAD
) || die
"No HEAD?"
455 UPSTREAM
=$
(git rev-parse
--verify "$1") || die
"Invalid base"
457 mkdir
"$DOTEST" || die
"Could not create temporary $DOTEST"
459 test -z "$ONTO" && ONTO
=$UPSTREAM
461 : > "$DOTEST"/interactive || die
"Could not mark as interactive"
462 git symbolic-ref HEAD
> "$DOTEST"/head-name
2> /dev
/null ||
463 echo "detached HEAD" > "$DOTEST"/head-name
465 echo $HEAD > "$DOTEST"/head
466 echo $UPSTREAM > "$DOTEST"/upstream
467 echo $ONTO > "$DOTEST"/onto
468 test -z "$STRATEGY" ||
echo "$STRATEGY" > "$DOTEST"/strategy
469 test t
= "$VERBOSE" && : > "$DOTEST"/verbose
470 if test t
= "$PRESERVE_MERGES"
472 # $REWRITTEN contains files for each commit that is
473 # reachable by at least one merge base of $HEAD and
474 # $UPSTREAM. They are not necessarily rewritten, but
475 # their children might be.
476 # This ensures that commits on merged, but otherwise
477 # unrelated side branches are left alone. (Think "X"
478 # in the man page's example.)
479 mkdir
"$REWRITTEN" &&
480 for c
in $
(git merge-base
--all $HEAD $UPSTREAM)
482 echo $ONTO > "$REWRITTEN"/$c ||
483 die
"Could not init rewritten commits"
487 MERGES_OPTION
=--no-merges
490 SHORTUPSTREAM
=$
(git rev-parse
--short $UPSTREAM)
491 SHORTHEAD
=$
(git rev-parse
--short $HEAD)
492 SHORTONTO
=$
(git rev-parse
--short $ONTO)
493 git rev-list
$MERGES_OPTION --pretty=oneline
--abbrev-commit \
494 --abbrev=7 --reverse --left-right --cherry-pick \
495 $UPSTREAM...
$HEAD | \
496 sed -n "s/^>/pick /p" > "$TODO"
497 cat >> "$TODO" << EOF
499 # Rebase $SHORTUPSTREAM..$SHORTHEAD onto $SHORTONTO
503 # edit = use commit, but stop for amending
504 # squash = use commit, but meld into previous commit
506 # If you remove a line here THAT COMMIT WILL BE LOST.
507 # However, if you remove everything, the rebase will be aborted.
511 has_action
"$TODO" ||
512 die_abort
"Nothing to do"
514 cp "$TODO" "$TODO".backup
515 git_editor
"$TODO" ||
516 die
"Could not execute editor"
518 has_action
"$TODO" ||
519 die_abort
"Nothing to do"
521 output git checkout
$ONTO && do_rest