"rebase -i": support special-purpose editor to edit insn sheet

The insn sheet used by "rebase -i" is designed to be easily editable by
any text editor, but an editor that is specifically meant for it (but
is otherwise unsuitable for editing regular text files) could be useful
by allowing drag & drop reordering in a GUI environment, for example.

The GIT_SEQUENCE_EDITOR environment variable and/or the sequence.editor
configuration variable can be used to specify such an editor, while
allowing the usual editor to be used to edit commit log messages. As
usual, the environment variable takes precedence over the configuration
variable.

It is envisioned that other "sequencer" based tools will use the same
mechanism.

Signed-off-by: Peter Oberndorfer <kumbayo84@arcor.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 0658ffb889320d408f2cad9214e138879059c766..611e35b206917e8731173fc4f2f5f6e73e679305 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -473,6 +473,12 @@ core.editor::
        variable when it is set, and the environment variable
        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 
        variable when it is set, and the environment variable
        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 

+sequence.editor::
+       Text editor used by `git rebase -i` for editing the rebase insn file.
+       The value is meant to be interpreted by the shell when it is used.
+       It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
+       When not configured the default commit message editor is used instead.
+

 core.pager::
        The command that git will use to paginate output.  Can
        be overridden with the `GIT_PAGER` environment
 core.pager::
        The command that git will use to paginate output.  Can
        be overridden with the `GIT_PAGER` environment

diff --git a/git-rebase--interactive.sh b/git-rebase--interactive.sh
index 94f36c254c53366ba53d256c0bd50a1de07cdb85..804001bb4e29873ef08d950a40cf1f1745e2aa27 100644 (file)
--- a/git-rebase--interactive.sh
+++ b/git-rebase--interactive.sh
@@ -161,6 +161,19 @@ do_with_author () {
        )
 }
 
        )
 }
 

+git_sequence_editor () {
+       if test -z "$GIT_SEQUENCE_EDITOR"
+       then
+               GIT_SEQUENCE_EDITOR="$(git config sequence.editor)"
+               if [ -z "$GIT_SEQUENCE_EDITOR" ]
+               then
+                       GIT_SEQUENCE_EDITOR="$(git var GIT_EDITOR)" || return $?
+               fi
+       fi
+
+       eval "$GIT_SEQUENCE_EDITOR" '"$@"'
+}
+

 pick_one () {
        ff=--ff
        case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac
 pick_one () {
        ff=--ff
        case "$1" in -n) sha1=$2; ff= ;; *) sha1=$1 ;; esac


@@ -832,7 +845,7 @@ has_action "$todo" ||
        die_abort "Nothing to do"
 
 cp "$todo" "$todo".backup
        die_abort "Nothing to do"
 
 cp "$todo" "$todo".backup

-git_editor "$todo" ||
+git_sequence_editor "$todo" ||

        die_abort "Could not execute editor"
 
 has_action "$todo" ||
        die_abort "Could not execute editor"
 
 has_action "$todo" ||