docs/git-tag: explain lightweight versus annotated tags
[gitweb.git] / git-rebase.sh
index e6167374445dfbb5e0b6bedc9a5f33a01cb5a7df..b2f1c76dc3ede707870564a8ba73af6d1753e95c 100755 (executable)
@@ -3,36 +3,12 @@
 # Copyright (c) 2005 Junio C Hamano.
 #
 
-USAGE='[--interactive | -i] [-v] [--force-rebase | -f] [--no-ff] [--onto <newbase>] [<upstream>|--root] [<branch>] [--quiet | -q]'
-LONG_USAGE='git-rebase replaces <branch> with a new branch of the
-same name.  When the --onto option is provided the new branch starts
-out with a HEAD equal to <newbase>, otherwise it is equal to <upstream>
-It then attempts to create a new commit for each commit from the original
-<branch> that does not exist in the <upstream> branch.
-
-It is possible that a merge failure will prevent this process from being
-completely automatic.  You will have to resolve any such merge failure
-and run git rebase --continue.  Another option is to bypass the commit
-that caused the merge failure with git rebase --skip.  To check out the
-original <branch> and remove the .git/rebase-apply working files, use the
-command git rebase --abort instead.
-
-Note that if <branch> is not specified on the command line, the
-currently checked out branch is used.
-
-Example:       git-rebase master~1 topic
-
-       A---B---C topic                   A'\''--B'\''--C'\'' topic
-       /                   -->           /
-  D---E---F---G master          D---E---F---G master
-'
-
 SUBDIRECTORY_OK=Yes
 OPTIONS_KEEPDASHDASH=
 OPTIONS_SPEC="\
-git rebase [-i] [options] [--onto <newbase>] [<upstream>] [<branch>]
-git rebase [-i] [options] --onto <newbase> --root [<branch>]
-git-rebase [-i] --continue | --abort | --skip
+git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] [<upstream>] [<branch>]
+git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] --root [<branch>]
+git-rebase --continue | --abort | --skip | --edit-todo
 --
  Available options are
 v,verbose!         display a diffstat of what changed upstream
@@ -43,6 +19,7 @@ s,strategy=!       use the given merge strategy
 no-ff!             cherry-pick all commits, even if unchanged
 m,merge!           use merging strategies to rebase
 i,interactive!     let the user edit the list of commits to rebase
+x,exec=!           add exec lines after each commit of the editable list
 k,keep-empty      preserve empty commits during rebase
 f,force-rebase!    force rebase even if branch is up to date
 X,strategy-option=! pass the argument through to the merge strategy
@@ -61,8 +38,10 @@ C=!                passed to 'git apply'
 continue!          continue
 abort!             abort and check out the original branch
 skip!              skip current patch and continue
+edit-todo!         edit the todo list during an interactive rebase
 "
 . git-sh-setup
+. git-sh-i18n
 set_reflog_action rebase
 require_work_tree_exists
 cd_to_toplevel
@@ -71,11 +50,12 @@ LF='
 '
 ok_to_skip_pre_rebase=
 resolvemsg="
-When you have resolved this problem run \"git rebase --continue\".
-If you would prefer to skip this patch, instead run \"git rebase --skip\".
-To check out the original branch and stop rebasing run \"git rebase --abort\".
+$(gettext 'When you have resolved this problem, run "git rebase --continue".
+If you prefer to skip this patch, run "git rebase --skip" instead.
+To check out the original branch and stop rebasing, run "git rebase --abort".')
 "
 unset onto
+cmd=
 strategy=
 strategy_opts=
 do_merge=
@@ -158,7 +138,7 @@ move_to_original_branch () {
                git symbolic-ref \
                        -m "rebase finished: returning to $head_name" \
                        HEAD $head_name ||
-               die "Could not move back to $head_name"
+               die "$(gettext "Could not move back to $head_name")"
                ;;
        esac
 }
@@ -177,12 +157,12 @@ run_pre_rebase_hook () {
           test -x "$GIT_DIR/hooks/pre-rebase"
        then
                "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} ||
-               die "The pre-rebase hook refused to rebase."
+               die "$(gettext "The pre-rebase hook refused to rebase.")"
        fi
 }
 
 test -f "$apply_dir"/applying &&
-       die 'It looks like git-am is in progress. Cannot rebase.'
+       die "$(gettext "It looks like git-am is in progress. Cannot rebase.")"
 
 if test -d "$apply_dir"
 then
@@ -211,7 +191,7 @@ do
        --verify)
                ok_to_skip_pre_rebase=
                ;;
-       --continue|--skip|--abort)
+       --continue|--skip|--abort|--edit-todo)
                test $total_argc -eq 2 || usage
                action=${1##--}
                ;;
@@ -220,6 +200,11 @@ do
                onto="$2"
                shift
                ;;
+       -x)
+               test 2 -le "$#" || usage
+               cmd="${cmd}exec $2${LF}"
+               shift
+               ;;
        -i)
                interactive_rebase=explicit
                ;;
@@ -305,9 +290,15 @@ do
 done
 test $# -gt 2 && usage
 
+if test -n "$cmd" &&
+   test "$interactive_rebase" != explicit
+then
+       die "$(gettext "The --exec option must be used with the --interactive option")"
+fi
+
 if test -n "$action"
 then
-       test -z "$in_progress" && die "No rebase in progress?"
+       test -z "$in_progress" && die "$(gettext "No rebase in progress?")"
        # Only interactive rebase uses detailed reflog messages
        if test "$type" = interactive && test "$GIT_REFLOG_ACTION" = rebase
        then
@@ -316,15 +307,20 @@ then
        fi
 fi
 
+if test "$action" = "edit-todo" && test "$type" != "interactive"
+then
+       die "$(gettext "The --edit-todo action can only be used during interactive rebase.")"
+fi
+
 case "$action" in
 continue)
        # Sanity check
        git rev-parse --verify HEAD >/dev/null ||
-               die "Cannot read HEAD"
+               die "$(gettext "Cannot read HEAD")"
        git update-index --ignore-submodules --refresh &&
        git diff-files --quiet --ignore-submodules || {
-               echo "You must edit all merge conflicts and then"
-               echo "mark them as resolved using git add"
+               echo "$(gettext "You must edit all merge conflicts and then
+mark them as resolved using git add")"
                exit 1
        }
        read_basic_state
@@ -341,27 +337,38 @@ abort)
        case "$head_name" in
        refs/*)
                git symbolic-ref -m "rebase: aborting" HEAD $head_name ||
-               die "Could not move back to $head_name"
+               die "$(eval_gettext "Could not move back to \$head_name")"
                ;;
        esac
        output git reset --hard $orig_head
        rm -r "$state_dir"
        exit
        ;;
+edit-todo)
+       run_specific_rebase
+       ;;
 esac
 
 # Make sure no rebase is in progress
 if test -n "$in_progress"
 then
-       die '
-It seems that there is already a '"${state_dir##*/}"' directory, and
+       state_dir_base=${state_dir##*/}
+       cmd_live_rebase="git rebase (--continue | --abort | --skip)"
+       cmd_clear_stale_rebase="rm -fr \"$state_dir\""
+       die "
+$(eval_gettext 'It seems that there is already a $state_dir_base directory, and
 I wonder if you are in the middle of another rebase.  If that is the
 case, please try
-       git rebase (--continue | --abort | --skip)
+       $cmd_live_rebase
 If that is not the case, please
-       rm -fr '"$state_dir"'
+       $cmd_clear_stale_rebase
 and run me again.  I am stopping in case you still have something
-valuable there.'
+valuable there.')"
+fi
+
+if test -n "$rebase_root" && test -z "$onto"
+then
+       test -z "$interactive_rebase" && interactive_rebase=implied
 fi
 
 if test -n "$interactive_rebase"
@@ -394,12 +401,18 @@ then
                ;;
        esac
        upstream=`git rev-parse --verify "${upstream_name}^0"` ||
-       die "invalid upstream $upstream_name"
+       die "$(eval_gettext "invalid upstream \$upstream_name")"
        upstream_arg="$upstream_name"
 else
-       test -z "$onto" && die "You must specify --onto when using --root"
+       if test -z "$onto"
+       then
+               empty_tree=`git hash-object -t tree /dev/null`
+               onto=`git commit-tree $empty_tree </dev/null`
+               squash_onto="$onto"
+       fi
        unset upstream_name
        unset upstream
+       test $# -gt 1 && usage
        upstream_arg=--root
 fi
 
@@ -412,19 +425,19 @@ case "$onto_name" in
        then
                case "$onto" in
                ?*"$LF"?*)
-                       die "$onto_name: there are more than one merge bases"
+                       die "$(eval_gettext "\$onto_name: there are more than one merge bases")"
                        ;;
                '')
-                       die "$onto_name: there is no merge base"
+                       die "$(eval_gettext "\$onto_name: there is no merge base")"
                        ;;
                esac
        else
-               die "$onto_name: there is no merge base"
+               die "$(eval_gettext "\$onto_name: there is no merge base")"
        fi
        ;;
 *)
        onto=$(git rev-parse --verify "${onto_name}^0") ||
-       die "Does not point to a valid commit: $onto_name"
+       die "$(eval_gettext "Does not point to a valid commit: \$onto_name")"
        ;;
 esac
 
@@ -447,10 +460,10 @@ case "$#" in
        then
                head_name="detached HEAD"
        else
-               die "fatal: no such branch: $1"
+               die "$(eval_gettext "fatal: no such branch: \$branch_name")"
        fi
        ;;
-*)
+0)
        # Do not need to switch branches, we are already on it.
        if branch_name=`git symbolic-ref -q HEAD`
        then
@@ -462,9 +475,12 @@ case "$#" in
        fi
        orig_head=$(git rev-parse --verify "${branch_name}^0") || exit
        ;;
+*)
+       die "BUG: unexpected number of arguments left to parse"
+       ;;
 esac
 
-require_clean_work_tree "rebase" "Please commit or stash them."
+require_clean_work_tree "rebase" "$(gettext "Please commit or stash them.")"
 
 # Now we are rebasing commits $upstream..$orig_head (or with --root,
 # everything leading up to $orig_head) on top of $onto
@@ -482,10 +498,10 @@ then
        then
                # Lazily switch to the target branch if needed...
                test -z "$switch_to" || git checkout "$switch_to" --
-               say "Current branch $branch_name is up to date."
+               say "$(eval_gettext "Current branch \$branch_name is up to date.")"
                exit 0
        else
-               say "Current branch $branch_name is up to date, rebase forced."
+               say "$(eval_gettext "Current branch \$branch_name is up to date, rebase forced.")"
        fi
 fi
 
@@ -496,7 +512,7 @@ if test -n "$diffstat"
 then
        if test -n "$verbose"
        then
-               echo "Changes from $mb to $onto:"
+               echo "$(eval_gettext "Changes from \$mb to \$onto:")"
        fi
        # We want color (if set), but no pager
        GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
@@ -505,7 +521,7 @@ fi
 test "$type" = interactive && run_specific_rebase
 
 # Detach HEAD and reset the tree
-say "First, rewinding head to replay your work on top of it..."
+say "$(gettext "First, rewinding head to replay your work on top of it...")"
 git checkout -q "$onto^0" || die "could not detach HEAD"
 git update-ref ORIG_HEAD $orig_head
 
@@ -513,7 +529,7 @@ git update-ref ORIG_HEAD $orig_head
 # we just fast-forwarded.
 if test "$mb" = "$orig_head"
 then
-       say "Fast-forwarded $branch_name to $onto_name."
+       say "$(eval_gettext "Fast-forwarded \$branch_name to \$onto_name.")"
        move_to_original_branch
        exit 0
 fi