Add an optional <mode> argument to commit/status -u|--untracked-files option
[git/git.git] / Documentation / git-commit.txt
CommitLineData
215a7ad1
JH
1git-commit(1)
2=============
62033318
JH
3
4NAME
5----
c3f0baac 6git-commit - Record changes to the repository
62033318
JH
7
8SYNOPSIS
9--------
353ce815 10[verse]
4bfee30a 11'git-commit' [-a | --interactive] [-s] [-v] [-u[<mode>]]
6cbf07ef 12 [(-c | -C) <commit> | -F <file> | -m <msg> | --amend]
36863af1 13 [--allow-empty] [--no-verify] [-e] [--author <author>]
5f065737 14 [--cleanup=<mode>] [--] [[-i | -o ]<file>...]
62033318
JH
15
16DESCRIPTION
17-----------
a76c2acb
BF
18Use 'git commit' to store the current contents of the index in a new
19commit along with a log message describing the changes you have made.
62033318 20
a76c2acb 21The content to be added can be specified in several ways:
f9935bf9 22
5162e697 231. by using linkgit:git-add[1] to incrementally "add" changes to the
a76c2acb 24 index before using the 'commit' command (Note: even modified
6c96753d 25 files must be "added");
5bfc4f23 26
5162e697 272. by using linkgit:git-rm[1] to remove files from the working tree
a76c2acb 28 and the index, again before using the 'commit' command;
6c96753d 29
a76c2acb
BF
303. by listing files as arguments to the 'commit' command, in which
31 case the commit will ignore changes staged in the index, and instead
32 record the current content of the listed files;
6c96753d 33
a76c2acb
BF
344. by using the -a switch with the 'commit' command to automatically
35 "add" changes from all known files (i.e. all files that are already
36 listed in the index) and to automatically "rm" files in the index
37 that have been removed from the working tree, and then perform the
38 actual commit;
6c96753d 39
6cbf07ef
PB
405. by using the --interactive switch with the 'commit' command to decide one
41 by one which files should be part of the commit, before finalizing the
42 operation. Currently, this is done by invoking `git-add --interactive`.
43
5162e697 44The linkgit:git-status[1] command can be used to obtain a
6c96753d
JH
45summary of what is included by any of the above for the next
46commit by giving the same set of parameters you would give to
47this command.
48
49If you make a commit and then found a mistake immediately after
5162e697 50that, you can recover from it with linkgit:git-reset[1].
5bfc4f23 51
6d35cc76 52
62033318
JH
53OPTIONS
54-------
eaa54efc 55-a|--all::
6c96753d
JH
56 Tell the command to automatically stage files that have
57 been modified and deleted, but new files you have not
58 told git about are not affected.
62033318
JH
59
60-c or -C <commit>::
61 Take existing commit object, and reuse the log message
62 and the authorship information (including the timestamp)
63 when creating the commit. With '-C', the editor is not
64 invoked; with '-c' the user can further edit the commit
65 message.
66
67-F <file>::
68 Take the commit message from the given file. Use '-' to
69 read the message from the standard input.
70
130fcca6
JH
71--author <author>::
72 Override the author name used in the commit. Use
73 `A U Thor <author@example.com>` format.
74
fd0368f9 75-m <msg>|--message=<msg>::
62033318
JH
76 Use the given <msg> as the commit message.
77
d1cc130a
SG
78-t <file>|--template=<file>::
79 Use the contents of the given file as the initial version
80 of the commit message. The editor is invoked and you can
81 make subsequent changes. If a message is specified using
383e45ce
BG
82 the `-m` or `-F` options, this option has no effect. This
83 overrides the `commit.template` configuration variable.
d1cc130a 84
eaa54efc 85-s|--signoff::
3f971fc4
JH
86 Add Signed-off-by line at the end of the commit message.
87
6c96753d 88--no-verify::
aa6da6cd 89 This option bypasses the pre-commit and commit-msg hooks.
a5af0e2c 90 See also linkgit:githooks[5][hooks].
eaa54efc 91
36863af1
JH
92--allow-empty::
93 Usually recording a commit that has the exact same tree as its
17ef10d0
JH
94 sole parent commit is a mistake, and the command prevents you
95 from making such a commit. This option bypasses the safety, and
96 is primarily for use by foreign scm interface scripts.
36863af1 97
5f065737
AR
98--cleanup=<mode>::
99 This option sets how the commit message is cleaned up.
100 The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
101 and 'default'. The 'default' mode will strip leading and
102 trailing empty lines and #commentary from the commit message
103 only if the message is to be edited. Otherwise only whitespace
104 removed. The 'verbatim' mode does not change message at all,
105 'whitespace' removes just leading/trailing whitespace lines
106 and 'strip' removes both whitespace and commentary.
107
eaa54efc 108-e|--edit::
6d35cc76
JH
109 The message taken from file with `-F`, command line with
110 `-m`, and from file with `-C` are usually used as the
111 commit log message unmodified. This option lets you
112 further edit the message taken from these sources.
113
ae5d8470
MR
114--amend::
115
116 Used to amend the tip of the current branch. Prepare the tree
117 object you would want to replace the latest commit as usual
118 (this includes the usual -i/-o and explicit paths), and the
119 commit log editor is seeded with the commit message from the
120 tip of the current branch. The commit you create replaces the
121 current tip -- if it was a merge, it will have the parents of
122 the current tip as parents -- so the current top commit is
123 discarded.
124+
6cbd5d7d 125--
ae5d8470 126It is a rough equivalent for:
6cbd5d7d 127------
ae5d8470
MR
128 $ git reset --soft HEAD^
129 $ ... do something else to come up with the right tree ...
130 $ git commit -c ORIG_HEAD
6cbd5d7d
FD
131
132------
ae5d8470 133but can be used to amend a merge commit.
6cbd5d7d 134--
ae5d8470 135
130fcca6 136-i|--include::
6c96753d
JH
137 Before making a commit out of staged contents so far,
138 stage the contents of paths given on the command line
139 as well. This is usually not what you want unless you
140 are concluding a conflicted merge.
62033318 141
d4ba07ca
JS
142-o|--only::
143 Make a commit only from the paths specified on the
144 command line, disregarding any contents that have been
145 staged so far. This is the default mode of operation of
146 'git commit' if any paths are given on the command line,
147 in which case this option can be omitted.
148 If this option is specified together with '--amend', then
149 no paths need be specified, which can be used to amend
150 the last commit without committing changes that have
151 already been staged.
152
4bfee30a
MSO
153-u[<mode>]|--untracked-files[=<mode>]::
154 Show untracked files (Default: 'all').
155+
156The mode parameter is optional, and is used to specify
157the handling of untracked files. The possible options are:
158+
159--
160 - 'normal' - Shows untracked files and directories
161 - 'all' - Also shows individual files in untracked directories.
162--
af83bed6
JN
163
164-v|--verbose::
165 Show unified diff between the HEAD commit and what
166 would be committed at the bottom of the commit message
167 template. Note that this diff output doesn't have its
168 lines prefixed with '#'.
169
ebd124c6 170-q|--quiet::
23bfbb81 171 Suppress commit summary message.
ebd124c6 172
e994004f 173\--::
4170a195
JH
174 Do not interpret any more arguments as options.
175
176<file>...::
6c96753d
JH
177 When files are given on the command line, the command
178 commits the contents of the named files, without
179 recording the changes already staged. The contents of
180 these files are also staged for the next commit on top
181 of what have been staged before.
3ae854c3
JH
182
183
6c96753d
JH
184EXAMPLES
185--------
186When recording your own work, the contents of modified files in
187your working tree are temporarily stored to a staging area
5162e697 188called the "index" with linkgit:git-add[1]. A file can be
97e9a221
JX
189reverted back, only in the index but not in the working tree,
190to that of the last commit with `git-reset HEAD -- <file>`,
191which effectively reverts `git-add` and prevents the changes to
192this file from participating in the next commit. After building
193the state to be committed incrementally with these commands,
194`git commit` (without any pathname parameter) is used to record what
6c96753d
JH
195has been staged so far. This is the most basic form of the
196command. An example:
197
198------------
199$ edit hello.c
200$ git rm goodbye.c
201$ git add hello.c
202$ git commit
203------------
204
6c96753d
JH
205Instead of staging files after each individual change, you can
206tell `git commit` to notice the changes to the files whose
207contents are tracked in
208your working tree and do corresponding `git add` and `git rm`
209for you. That is, this example does the same as the earlier
210example if there is no other change in your working tree:
211
212------------
213$ edit hello.c
214$ rm goodbye.c
215$ git commit -a
216------------
217
218The command `git commit -a` first looks at your working tree,
219notices that you have modified hello.c and removed goodbye.c,
220and performs necessary `git add` and `git rm` for you.
221
222After staging changes to many files, you can alter the order the
223changes are recorded in, by giving pathnames to `git commit`.
224When pathnames are given, the command makes a commit that
225only records the changes made to the named paths:
226
227------------
228$ edit hello.c hello.h
229$ git add hello.c hello.h
230$ edit Makefile
231$ git commit Makefile
232------------
233
234This makes a commit that records the modification to `Makefile`.
235The changes staged for `hello.c` and `hello.h` are not included
236in the resulting commit. However, their changes are not lost --
237they are still staged and merely held back. After the above
238sequence, if you do:
239
240------------
241$ git commit
242------------
243
244this second commit would record the changes to `hello.c` and
245`hello.h` as expected.
246
5162e697
DM
247After a merge (initiated by either linkgit:git-merge[1] or
248linkgit:git-pull[1]) stops because of conflicts, cleanly merged
6c96753d
JH
249paths are already staged to be committed for you, and paths that
250conflicted are left in unmerged state. You would have to first
5162e697 251check which paths are conflicting with linkgit:git-status[1]
6c96753d 252and after fixing them manually in your working tree, you would
5162e697 253stage the result as usual with linkgit:git-add[1]:
6c96753d
JH
254
255------------
256$ git status | grep unmerged
257unmerged: hello.c
258$ edit hello.c
259$ git add hello.c
260------------
261
262After resolving conflicts and staging the result, `git ls-files -u`
263would stop mentioning the conflicted path. When you are done,
264run `git commit` to finally record the merge:
265
266------------
267$ git commit
268------------
269
270As with the case to record your own changes, you can use `-a`
271option to save typing. One difference is that during a merge
272resolution, you cannot use `git commit` with pathnames to
273alter the order the changes are committed, because the merge
274should be recorded as a single commit. In fact, the command
275refuses to run when given pathnames (but see `-i` option).
276
277
5dc7bcc2
JH
278DISCUSSION
279----------
280
936f32d3
JH
281Though not required, it's a good idea to begin the commit message
282with a single short (less than 50 character) line summarizing the
283change, followed by a blank line and then a more thorough description.
284Tools that turn commits into email, for example, use the first line
285on the Subject: line and the rest of the commit in the body.
286
5dc7bcc2
JH
287include::i18n.txt[]
288
ef0c2abf
AR
289ENVIRONMENT AND CONFIGURATION VARIABLES
290---------------------------------------
291The editor used to edit the commit log message will be chosen from the
292GIT_EDITOR environment variable, the core.editor configuration variable, the
293VISUAL environment variable, or the EDITOR environment variable (in that
294order).
6c96753d
JH
295
296HOOKS
297-----
8089c85b 298This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
a5af0e2c 299and `post-commit` hooks. See linkgit:githooks[5][hooks] for more
6c96753d 300information.
130fcca6 301
130fcca6 302
6c96753d
JH
303SEE ALSO
304--------
5162e697
DM
305linkgit:git-add[1],
306linkgit:git-rm[1],
307linkgit:git-mv[1],
308linkgit:git-merge[1],
309linkgit:git-commit-tree[1]
130fcca6 310
62033318
JH
311Author
312------
3f971fc4
JH
313Written by Linus Torvalds <torvalds@osdl.org> and
314Junio C Hamano <junkio@cox.net>
315
62033318
JH
316
317GIT
318---
9e1f0a85 319Part of the linkgit:git[1] suite