update usage string for git-commit.sh
[git.git] / git-commit.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2005 Linus Torvalds
4 #
5
6 . git-sh-setup || die "Not a git archive"
7
8 usage () {
9         die 'git commit [-a] [-s] [-v | --no-verify]  [-m <message> | -F <logfile> | (-C|-c) <commit>] [-e] [<path>...]'
10 }
11
12 all= logfile= use_commit= no_edit= log_given= log_message= verify=t signoff=
13 while case "$#" in 0) break;; esac
14 do
15   case "$1" in
16   -a|--a|--al|--all)
17     all=t
18     shift ;;
19   -F=*|--f=*|--fi=*|--fil=*|--file=*)
20     log_given=t$log_given
21     logfile=`expr "$1" : '-[^=]*=\(.*\)'`
22     no_edit=t
23     shift ;;
24   -F|--f|--fi|--fil|--file)
25     case "$#" in 1) usage ;; esac; shift
26     log_given=t$log_given
27     logfile="$1"
28     no_edit=t
29     shift ;;
30   -m=*|--m=*|--me=*|--mes=*|--mess=*|--messa=*|--messag=*|--message=*)
31     log_given=t$log_given
32     log_message=`expr "$1" : '-[^=]*=\(.*\)'`
33     no_edit=t
34     shift ;;
35   -m|--m|--me|--mes|--mess|--messa|--messag|--message)
36     case "$#" in 1) usage ;; esac; shift
37     log_given=t$log_given
38     log_message="$1"
39     no_edit=t
40     shift ;;
41   -c=*|--ree=*|--reed=*|--reedi=*|--reedit=*|--reedit-=*|--reedit-m=*|\
42   --reedit-me=*|--reedit-mes=*|--reedit-mess=*|--reedit-messa=*|\
43   --reedit-messag=*|--reedit-message=*)
44     log_given=t$log_given
45     use_commit=`expr "$1" : '-[^=]*=\(.*\)'`
46     shift ;;
47   -c|--ree|--reed|--reedi|--reedit|--reedit-|--reedit-m|--reedit-me|\
48   --reedit-mes|--reedit-mess|--reedit-messa|--reedit-messag|--reedit-message)
49     case "$#" in 1) usage ;; esac; shift
50     log_given=t$log_given
51     use_commit="$1"
52     shift ;;
53   -C=*|--reu=*|--reus=*|--reuse=*|--reuse-=*|--reuse-m=*|--reuse-me=*|\
54   --reuse-mes=*|--reuse-mess=*|--reuse-messa=*|--reuse-messag=*|\
55   --reuse-message=*)
56     log_given=t$log_given
57     use_commit=`expr "$1" : '-[^=]*=\(.*\)'`
58     no_edit=t
59     shift ;;
60   -C|--reu|--reus|--reuse|--reuse-|--reuse-m|--reuse-me|--reuse-mes|\
61   --reuse-mess|--reuse-messa|--reuse-messag|--reuse-message)
62     case "$#" in 1) usage ;; esac; shift
63     log_given=t$log_given
64     use_commit="$1"
65     no_edit=t
66     shift ;;
67   -e|--e|--ed|--edi|--edit)
68     no_edit=
69     shift ;;
70   -s|--s|--si|--sig|--sign|--signo|--signof|--signoff)
71     signoff=t
72     shift ;;
73   -n|--n|--no|--no-|--no-v|--no-ve|--no-ver|--no-veri|--no-verif|--no-verify)
74     verify=
75     shift ;;
76   -v|--v|--ve|--ver|--veri|--verif|--verify)
77     verify=t
78     shift ;;
79   --)
80     shift
81     break ;;
82   -*)
83      usage ;;
84   *)
85     break ;;
86   esac
87 done
88
89 case "$log_given" in
90 tt*)
91   die "Only one of -c/-C/-F/-m can be used." ;;
92 esac
93
94 case "$all,$#" in
95 t,*)
96         git-diff-files --name-only -z |
97         git-update-index --remove -z --stdin
98         ;;
99 ,0)
100         ;;
101 *)
102         git-diff-files --name-only -z -- "$@" |
103         git-update-index --remove -z --stdin
104         ;;
105 esac || exit 1
106 git-update-index -q --refresh || exit 1
107
108 case "$verify" in
109 t)
110         if test -x "$GIT_DIR"/hooks/pre-commit
111         then
112                 "$GIT_DIR"/hooks/pre-commit || exit
113         fi
114 esac
115
116 if test "$log_message" != ''
117 then
118         echo "$log_message"
119 elif test "$logfile" != ""
120 then
121         if test "$logfile" = -
122         then
123                 test -t 0 &&
124                 echo >&2 "(reading log message from standard input)"
125                 cat
126         else
127                 cat <"$logfile"
128         fi
129 elif test "$use_commit" != ""
130 then
131         git-cat-file commit "$use_commit" | sed -e '1,/^$/d'
132 fi | git-stripspace >"$GIT_DIR"/COMMIT_EDITMSG
133
134 case "$signoff" in
135 t)
136         {
137                 echo
138                 git-var GIT_COMMITTER_IDENT | sed -e '
139                         s/>.*/>/
140                         s/^/Signed-off-by: /
141                 '
142         } >>"$GIT_DIR"/COMMIT_EDITMSG
143         ;;
144 esac
145
146 if [ -f "$GIT_DIR/MERGE_HEAD" ]; then
147
148         test -f "$GIT_DIR/MERGE_MSG" && cat "$GIT_DIR/MERGE_MSG"
149
150         echo "#"
151         echo "# It looks like your may be committing a MERGE."
152         echo "# If this is not correct, please remove the file"
153         echo "# $GIT_DIR/MERGE_HEAD"
154         echo "# and try again"
155         echo "#"
156 fi >>"$GIT_DIR"/COMMIT_EDITMSG
157
158 PARENTS="-p HEAD"
159 if GIT_DIR="$GIT_DIR" git-rev-parse --verify HEAD >/dev/null 2>&1
160 then
161         if [ -f "$GIT_DIR/MERGE_HEAD" ]; then
162                 PARENTS="-p HEAD "`sed -e 's/^/-p /' "$GIT_DIR/MERGE_HEAD"`
163         fi
164         if test "$use_commit" != ""
165         then
166                 pick_author_script='
167                 /^author /{
168                         h
169                         s/^author \([^<]*\) <[^>]*> .*$/\1/
170                         s/'\''/'\''\'\'\''/g
171                         s/.*/GIT_AUTHOR_NAME='\''&'\''/p
172
173                         g
174                         s/^author [^<]* <\([^>]*\)> .*$/\1/
175                         s/'\''/'\''\'\'\''/g
176                         s/.*/GIT_AUTHOR_EMAIL='\''&'\''/p
177
178                         g
179                         s/^author [^<]* <[^>]*> \(.*\)$/\1/
180                         s/'\''/'\''\'\'\''/g
181                         s/.*/GIT_AUTHOR_DATE='\''&'\''/p
182
183                         q
184                 }
185                 '
186                 set_author_env=`git-cat-file commit "$use_commit" |
187                 sed -ne "$pick_author_script"`
188                 eval "$set_author_env"
189                 export GIT_AUTHOR_NAME
190                 export GIT_AUTHOR_EMAIL
191                 export GIT_AUTHOR_DATE
192         fi
193 else
194         if [ -z "$(git-ls-files)" ]; then
195                 echo Nothing to commit 1>&2
196                 exit 1
197         fi
198         PARENTS=""
199 fi
200 git-status >>"$GIT_DIR"/COMMIT_EDITMSG
201 if [ "$?" != "0" -a ! -f "$GIT_DIR/MERGE_HEAD" ]
202 then
203         rm -f "$GIT_DIR/COMMIT_EDITMSG"
204         git-status
205         exit 1
206 fi
207 case "$no_edit" in
208 '')
209         ${VISUAL:-${EDITOR:-vi}} "$GIT_DIR/COMMIT_EDITMSG"
210         ;;
211 esac
212
213 case "$verify" in
214 t)
215         if test -x "$GIT_DIR"/hooks/commit-msg
216         then
217                 "$GIT_DIR"/hooks/commit-msg "$GIT_DIR"/COMMIT_EDITMSG || exit
218         fi
219 esac
220
221 grep -v '^#' < "$GIT_DIR"/COMMIT_EDITMSG |
222 git-stripspace > "$GIT_DIR"/COMMIT_MSG
223
224 if cnt=`grep -v -i '^Signed-off-by' "$GIT_DIR"/COMMIT_MSG |
225         git-stripspace |
226         wc -l` &&
227    test 0 -lt $cnt
228 then
229         tree=$(git-write-tree) &&
230         commit=$(cat "$GIT_DIR"/COMMIT_MSG | git-commit-tree $tree $PARENTS) &&
231         git-update-ref HEAD $commit $current &&
232         rm -f -- "$GIT_DIR/MERGE_HEAD"
233 else
234         echo >&2 "* no commit message?  aborting commit."
235         false
236 fi
237 ret="$?"
238 rm -f "$GIT_DIR/COMMIT_MSG" "$GIT_DIR/COMMIT_EDITMSG"
239
240 if test -x "$GIT_DIR"/hooks/post-commit && test "$ret" = 0
241 then
242         "$GIT_DIR"/hooks/post-commit
243 fi
244 exit "$ret"