git-sh-setup.sh: make GIT_EDITOR/core.editor/VISUAL/EDITOR accept commands
[gitweb.git] / git-commit.sh
index 9106a743cc90f532be2c83d3a73799566b95df6a..4290ae2dd2747b26c521300af1ed5e46ab839264 100755 (executable)
@@ -3,7 +3,7 @@
 # Copyright (c) 2005 Linus Torvalds
 # Copyright (c) 2006 Junio C Hamano
 
-USAGE='[-a | --interactive] [-s] [-v] [--no-verify] [-m <message> | -F <logfile> | (-C|-c) <commit> | --amend] [-u] [-e] [--author <author>] [[-i | -o] <path>...]'
+USAGE='[-a | --interactive] [-s] [-v] [--no-verify] [-m <message> | -F <logfile> | (-C|-c) <commit> | --amend] [-u] [-e] [--author <author>] [--template <file>] [[-i | -o] <path>...]'
 SUBDIRECTORY_OK=Yes
 . git-sh-setup
 require_work_tree
@@ -87,6 +87,7 @@ signoff=
 force_author=
 only_include_assumed=
 untracked_files=
+templatefile="`git config commit.template`"
 while case "$#" in 0) break;; esac
 do
        case "$1" in
@@ -248,6 +249,13 @@ $1"
                signoff=t
                shift
                ;;
+       -t|--t|--te|--tem|--temp|--templ|--templa|--templat|--template)
+               case "$#" in 1) usage ;; esac
+               shift
+               templatefile="$1"
+               no_edit=
+               shift
+               ;;
        -q|--q|--qu|--qui|--quie|--quiet)
                quiet=t
                shift
@@ -321,6 +329,14 @@ t,,[1-9]*)
        die "No paths with -i does not make sense." ;;
 esac
 
+if test ! -z "$templatefile" -a -z "$log_given"
+then
+       if test ! -f "$templatefile"
+       then
+               die "Commit template file does not exist."
+       fi
+fi
+
 ################################################################
 # Prepare index to have a tree to be committed
 
@@ -454,20 +470,25 @@ then
 elif test -f "$GIT_DIR/SQUASH_MSG"
 then
        cat "$GIT_DIR/SQUASH_MSG"
+elif test "$templatefile" != ""
+then
+       cat "$templatefile"
 fi | git stripspace >"$GIT_DIR"/COMMIT_EDITMSG
 
 case "$signoff" in
 t)
-       need_blank_before_signoff=
+       sign=$(git-var GIT_COMMITTER_IDENT | sed -e '
+               s/>.*/>/
+               s/^/Signed-off-by: /
+               ')
+       blank_before_signoff=
        tail -n 1 "$GIT_DIR"/COMMIT_EDITMSG |
-       grep 'Signed-off-by:' >/dev/null || need_blank_before_signoff=yes
-       {
-               test -z "$need_blank_before_signoff" || echo
-               git-var GIT_COMMITTER_IDENT | sed -e '
-                       s/>.*/>/
-                       s/^/Signed-off-by: /
-               '
-       } >>"$GIT_DIR"/COMMIT_EDITMSG
+       grep 'Signed-off-by:' >/dev/null || blank_before_signoff='
+'
+       tail -n 1 "$GIT_DIR"/COMMIT_EDITMSG |
+       grep "$sign"$ >/dev/null ||
+       printf '%s%s\n' "$blank_before_signoff" "$sign" \
+               >>"$GIT_DIR"/COMMIT_EDITMSG
        ;;
 esac
 
@@ -542,18 +563,9 @@ fi
 
 case "$no_edit" in
 '')
-       case "${VISUAL:-$EDITOR},$TERM" in
-       ,dumb)
-               echo >&2 "Terminal is dumb but no VISUAL nor EDITOR defined."
-               echo >&2 "Please supply the commit log message using either"
-               echo >&2 "-m or -F option.  A boilerplate log message has"
-               echo >&2 "been prepared in $GIT_DIR/COMMIT_EDITMSG"
-               exit 1
-               ;;
-       esac
        git-var GIT_AUTHOR_IDENT > /dev/null  || die
        git-var GIT_COMMITTER_IDENT > /dev/null  || die
-       ${VISUAL:-${EDITOR:-vi}} "$GIT_DIR/COMMIT_EDITMSG"
+       git_editor "$GIT_DIR/COMMIT_EDITMSG"
        ;;
 esac
 
@@ -579,10 +591,35 @@ else
 fi |
 git stripspace >"$GIT_DIR"/COMMIT_MSG
 
-if cnt=`grep -v -i '^Signed-off-by' "$GIT_DIR"/COMMIT_MSG |
-       git stripspace |
-       wc -l` &&
-   test 0 -lt $cnt
+# Test whether the commit message has any content we didn't supply.
+have_commitmsg=
+grep -v -i '^Signed-off-by' "$GIT_DIR"/COMMIT_MSG |
+       git stripspace > "$GIT_DIR"/COMMIT_BAREMSG
+
+# Is the commit message totally empty?
+if test -s "$GIT_DIR"/COMMIT_BAREMSG
+then
+       if test "$templatefile" != ""
+       then
+               # Test whether this is just the unaltered template.
+               if cnt=`sed -e '/^#/d' < "$templatefile" |
+                       git stripspace |
+                       diff "$GIT_DIR"/COMMIT_BAREMSG - |
+                       wc -l` &&
+                  test 0 -lt $cnt
+               then
+                       have_commitmsg=t
+               fi
+       else
+               # No template, so the content in the commit message must
+               # have come from the user.
+               have_commitmsg=t
+       fi
+fi
+
+rm -f "$GIT_DIR"/COMMIT_BAREMSG
+
+if test "$have_commitmsg" = "t"
 then
        if test -z "$TMP_INDEX"
        then
@@ -591,7 +628,7 @@ then
                tree=$(GIT_INDEX_FILE="$TMP_INDEX" git write-tree) &&
                rm -f "$TMP_INDEX"
        fi &&
-       commit=$(cat "$GIT_DIR"/COMMIT_MSG | git commit-tree $tree $PARENTS) &&
+       commit=$(git commit-tree $tree $PARENTS <"$GIT_DIR/COMMIT_MSG") &&
        rlogm=$(sed -e 1q "$GIT_DIR"/COMMIT_MSG) &&
        git update-ref -m "$GIT_REFLOG_ACTION: $rlogm" HEAD $commit "$current" &&
        rm -f -- "$GIT_DIR/MERGE_HEAD" "$GIT_DIR/MERGE_MSG" &&