Rework pretty_print_commit to use strbufs instead of custom buffers.
[gitweb.git] / git-commit.sh
index f28fc242241d3f0f5c88b287da0c59417667a013..1d04f1ff31cf99a6dec1d52866668007ab2dae72 100755 (executable)
@@ -3,12 +3,12 @@
 # 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
 
-git-rev-parse --verify HEAD >/dev/null 2>&1 || initial_commit=t
+git rev-parse --verify HEAD >/dev/null 2>&1 || initial_commit=t
 
 case "$0" in
 *status)
@@ -49,11 +49,12 @@ run_status () {
                export GIT_INDEX_FILE
        fi
 
-       case "$status_only" in
-       t) color= ;;
-       *) color=--nocolor ;;
-       esac
-       git-runstatus ${color} \
+       if test "$status_only" = "t" -o "$use_status_color" = "t"; then
+               color=
+       else
+               color=--nocolor
+       fi
+       git runstatus ${color} \
                ${verbose:+--verbose} \
                ${amend:+--amend} \
                ${untracked_files:+--untracked}
@@ -87,6 +88,7 @@ signoff=
 force_author=
 only_include_assumed=
 untracked_files=
+templatefile="`git config commit.template`"
 while case "$#" in 0) break;; esac
 do
        case "$1" in
@@ -189,7 +191,6 @@ $1"
                ;;
        --a|--am|--ame|--amen|--amend)
                amend=t
-               log_given=t$log_given
                use_commit=HEAD
                shift
                ;;
@@ -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
@@ -290,9 +298,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 +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
 
@@ -335,20 +351,20 @@ t,)
                cd_to_toplevel &&
                GIT_INDEX_FILE="$NEXT_INDEX" &&
                export GIT_INDEX_FILE &&
-               git-diff-files --name-only -z |
-               git-update-index --remove -z --stdin
+               git diff-files --name-only -z |
+               git update-index --remove -z --stdin
        ) || exit
        ;;
 ,t)
        save_index &&
-       git-ls-files --error-unmatch -- "$@" >/dev/null || exit
+       git ls-files --error-unmatch -- "$@" >/dev/null || exit
 
-       git-diff-files --name-only -z -- "$@"  |
+       git diff-files --name-only -z -- "$@"  |
        (
                cd_to_toplevel &&
                GIT_INDEX_FILE="$NEXT_INDEX" &&
                export GIT_INDEX_FILE &&
-               git-update-index --remove -z --stdin
+               git update-index --remove -z --stdin
        ) || exit
        ;;
 ,)
@@ -364,28 +380,28 @@ t,)
                        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
+               commit_only=`git ls-files --error-unmatch -- "$@"` || exit
 
                # Build a temporary index and update the real index
                # the same way.
                if test -z "$initial_commit"
                then
                        GIT_INDEX_FILE="$THIS_INDEX" \
-                       git-read-tree --index-output="$TMP_INDEX" -i -m HEAD
+                       git read-tree --index-output="$TMP_INDEX" -i -m HEAD
                else
                        rm -f "$TMP_INDEX"
                fi || exit
 
-               echo "$commit_only" |
+               printf '%s\n' "$commit_only" |
                GIT_INDEX_FILE="$TMP_INDEX" \
-               git-update-index --add --remove --stdin &&
+               git update-index --add --remove --stdin &&
 
                save_index &&
-               echo "$commit_only" |
+               printf '%s\n' "$commit_only" |
                (
                        GIT_INDEX_FILE="$NEXT_INDEX"
                        export GIT_INDEX_FILE
-                       git-update-index --remove --stdin
+                       git update-index --remove --stdin
                ) || exit
                ;;
        esac
@@ -408,12 +424,12 @@ case "$status_only" in
 t)
        # This will silently fail in a read-only repository, which is
        # what we want.
-       GIT_INDEX_FILE="$USE_INDEX" git-update-index -q --unmerged --refresh
+       GIT_INDEX_FILE="$USE_INDEX" git update-index -q --unmerged --refresh
        run_status
        exit $?
        ;;
 '')
-       GIT_INDEX_FILE="$USE_INDEX" git-update-index -q --refresh || exit
+       GIT_INDEX_FILE="$USE_INDEX" git update-index -q --refresh || exit
        ;;
 esac
 
@@ -432,7 +448,7 @@ fi
 
 if test "$log_message" != ''
 then
-       echo "$log_message"
+       printf '%s\n' "$log_message"
 elif test "$logfile" != ""
 then
        if test "$logfile" = -
@@ -454,20 +470,25 @@ then
 elif test -f "$GIT_DIR/SQUASH_MSG"
 then
        cat "$GIT_DIR/SQUASH_MSG"
-fi | git-stripspace >"$GIT_DIR"/COMMIT_EDITMSG
+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
 
@@ -475,7 +496,7 @@ if test -f "$GIT_DIR/MERGE_HEAD" && test -z "$no_edit"; then
        echo "#"
        echo "# It looks like you may be committing a MERGE."
        echo "# If this is not correct, please remove the file"
-       echo "# $GIT_DIR/MERGE_HEAD"
+       printf '%s\n' "#        $GIT_DIR/MERGE_HEAD"
        echo "# and try again"
        echo "#"
 fi >>"$GIT_DIR"/COMMIT_EDITMSG
@@ -483,34 +504,8 @@ fi >>"$GIT_DIR"/COMMIT_EDITMSG
 # Author
 if test '' != "$use_commit"
 then
-       pick_author_script='
-       /^author /{
-               s/'\''/'\''\\'\'\''/g
-               h
-               s/^author \([^<]*\) <[^>]*> .*$/\1/
-               s/'\''/'\''\'\'\''/g
-               s/.*/GIT_AUTHOR_NAME='\''&'\''/p
-
-               g
-               s/^author [^<]* <\([^>]*\)> .*$/\1/
-               s/'\''/'\''\'\'\''/g
-               s/.*/GIT_AUTHOR_EMAIL='\''&'\''/p
-
-               g
-               s/^author [^<]* <[^>]*> \(.*\)$/\1/
-               s/'\''/'\''\'\'\''/g
-               s/.*/GIT_AUTHOR_DATE='\''&'\''/p
-
-               q
-       }
-       '
-       encoding=$(git config i18n.commitencoding || echo UTF-8)
-       set_author_env=`git show -s --pretty=raw --encoding="$encoding" "$use_commit" |
-       LANG=C LC_ALL=C sed -ne "$pick_author_script"`
-       eval "$set_author_env"
-       export GIT_AUTHOR_NAME
-       export GIT_AUTHOR_EMAIL
-       export GIT_AUTHOR_DATE
+       eval "$(get_author_ident_from_commit "$use_commit")"
+       export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
 fi
 if test '' != "$force_author"
 then
@@ -531,12 +526,12 @@ then
                PARENTS="-p HEAD "`sed -e 's/^/-p /' "$GIT_DIR/MERGE_HEAD"`
        elif test -n "$amend"; then
                rloga='commit (amend)'
-               PARENTS=$(git-cat-file commit HEAD |
+               PARENTS=$(git cat-file commit HEAD |
                        sed -n -e '/^$/q' -e 's/^parent /-p /p')
        fi
-       current="$(git-rev-parse --verify HEAD)"
+       current="$(git rev-parse --verify HEAD)"
 else
-       if [ -z "$(git-ls-files)" ]; then
+       if [ -z "$(git ls-files)" ]; then
                echo >&2 'nothing to commit (use "git add file1 file2" to include for commit)'
                exit 1
        fi
@@ -557,29 +552,21 @@ then
        } >>"$GIT_DIR"/COMMIT_EDITMSG
 else
        # we need to check if there is anything to commit
-       run_status >/dev/null 
+       run_status >/dev/null
 fi
 if [ "$?" != "0" -a ! -f "$GIT_DIR/MERGE_HEAD" -a -z "$amend" ]
 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
 
@@ -603,23 +590,48 @@ then
 else
     cat "$GIT_DIR"/COMMIT_EDITMSG
 fi |
-git-stripspace >"$GIT_DIR"/COMMIT_MSG
+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
-               tree=$(GIT_INDEX_FILE="$USE_INDEX" git-write-tree)
+               tree=$(GIT_INDEX_FILE="$USE_INDEX" git write-tree)
        else
-               tree=$(GIT_INDEX_FILE="$TMP_INDEX" git-write-tree) &&
+               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" &&
+       git update-ref -m "$GIT_REFLOG_ACTION: $rlogm" HEAD $commit "$current" &&
        rm -f -- "$GIT_DIR/MERGE_HEAD" "$GIT_DIR/MERGE_MSG" &&
        if test -f "$NEXT_INDEX"
        then
@@ -636,10 +648,7 @@ rm -f "$GIT_DIR/COMMIT_MSG" "$GIT_DIR/COMMIT_EDITMSG" "$GIT_DIR/SQUASH_MSG"
 
 cd_to_toplevel
 
-if test -d "$GIT_DIR/rr-cache"
-then
-       git-rerere
-fi
+git rerere
 
 if test "$ret" = 0
 then
@@ -649,7 +658,7 @@ then
        fi
        if test -z "$quiet"
        then
-               commit=`git-diff-tree --always --shortstat --pretty="format:%h: %s"\
+               commit=`git diff-tree --always --shortstat --pretty="format:%h: %s"\
                       --summary --root HEAD --`
                echo "Created${initial_commit:+ initial} commit $commit"
        fi