git-clone.txt: Improve --depth description.

[thirdparty/git.git] / git-commit.sh

diff --git a/git-commit.sh b/git-commit.sh
index f3cd8ee97839578bbfc719fd37d5b25b826623a8..ab43217be4b49ce71ffee461569e0e4b395dfb5d 100755 (executable)
--- a/git-commit.sh
+++ b/git-commit.sh
@@ -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
@@ -25,6 +25,7 @@ refuse_partial () {
        exit 1
 }
 
+TMP_INDEX=
 THIS_INDEX="$GIT_DIR/index"
 NEXT_INDEX="$GIT_DIR/next-index$$"
 rm -f "$NEXT_INDEX"
@@ -49,10 +50,11 @@ run_status () {
                export GIT_INDEX_FILE
        fi
 
-       case "$status_only" in
-       t) color= ;;
-       *) color=--nocolor ;;
-       esac
+       if test "$status_only" = "t" -o "$use_status_color" = "t"; then
+               color=
+       else
+               color=--nocolor
+       fi
        git runstatus ${color} \
                ${verbose:+--verbose} \
                ${amend:+--amend} \
@@ -87,7 +89,8 @@ signoff=
 force_author=
 only_include_assumed=
 untracked_files=
-while case "$#" in 0) break;; esac
+templatefile="`git config commit.template`"
+while test $# != 0
 do
        case "$1" in
        -F|--F|-f|--f|--fi|--fil|--file)
@@ -189,7 +192,6 @@ $1"
                ;;
        --a|--am|--ame|--amen|--amend)
                amend=t
-               log_given=t$log_given
                use_commit=HEAD
                shift
                ;;
@@ -248,6 +250,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
@@ -290,9 +299,9 @@ esac
 
 case "$log_given" in
 tt*)
-       die "Only one of -c/-C/-F/--amend can be used." ;;
+       die "Only one of -c/-C/-F can be used." ;;
 *tm*|*mt*)
-       die "Option -m cannot be combined with -c/-C/-F/--amend." ;;
+       die "Option -m cannot be combined with -c/-C/-F." ;;
 esac
 
 case "$#,$also,$only,$amend" in
@@ -321,6 +330,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
 
@@ -363,8 +380,11 @@ t,)
                then
                        refuse_partial "Cannot do a partial commit during a merge."
                fi
+
                TMP_INDEX="$GIT_DIR/tmp-index$$"
-               commit_only=`git ls-files --error-unmatch -- "$@"` || exit
+               W=
+               test -z "$initial_commit" && W=--with-tree=HEAD
+               commit_only=`git ls-files --error-unmatch $W -- "$@"` || exit
 
                # Build a temporary index and update the real index
                # the same way.
@@ -385,7 +405,7 @@ t,)
                (
                        GIT_INDEX_FILE="$NEXT_INDEX"
                        export GIT_INDEX_FILE
-                       git update-index --remove --stdin
+                       git update-index --add --remove --stdin
                ) || exit
                ;;
        esac
@@ -454,6 +474,9 @@ 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
@@ -535,27 +558,19 @@ else
        # we need to check if there is anything to commit
        run_status >/dev/null
 fi
-if [ "$?" != "0" -a ! -f "$GIT_DIR/MERGE_HEAD" -a -z "$amend" ]
+if [ "$?" != "0" -a ! -f "$GIT_DIR/MERGE_HEAD" ]
 then
        rm -f "$GIT_DIR/COMMIT_EDITMSG" "$GIT_DIR/SQUASH_MSG"
+       use_status_color=t
        run_status
        exit 1
 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
 
@@ -581,10 +596,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
@@ -593,7 +633,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" &&