Merge branch 'ho/dirstat-by-file'
[git/dscho.git] / Documentation / git-commit.txt
blobeb05b0f49b0c513581150415d1a4e679d7bfbea6
1 git-commit(1)
2 =============
4 NAME
5 ----
6 git-commit - Record changes to the repository
8 SYNOPSIS
9 --------
10 [verse]
11 'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend]
12            [(-c | -C) <commit>] [-F <file> | -m <msg>]
13            [--allow-empty] [--no-verify] [-e] [--author=<author>]
14            [--cleanup=<mode>] [--] [[-i | -o ]<file>...]
16 DESCRIPTION
17 -----------
18 Stores the current contents of the index in a new commit along
19 with a log message from the user describing the changes.
21 The content to be added can be specified in several ways:
23 1. by using 'git-add' to incrementally "add" changes to the
24    index before using the 'commit' command (Note: even modified
25    files must be "added");
27 2. by using 'git-rm' to remove files from the working tree
28    and the index, again before using the 'commit' command;
30 3. 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;
34 4. 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;
40 5. 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'.
44 The 'git-status' command can be used to obtain a
45 summary of what is included by any of the above for the next
46 commit by giving the same set of parameters you would give to
47 this command.
49 If you make a commit and then find a mistake immediately after
50 that, you can recover from it with 'git-reset'.
53 OPTIONS
54 -------
55 -a::
56 --all::
57         Tell the command to automatically stage files that have
58         been modified and deleted, but new files you have not
59         told git about are not affected.
61 -C <commit>::
62 --reuse-message=<commit>::
63         Take an existing commit object, and reuse the log message
64         and the authorship information (including the timestamp)
65         when creating the commit.
67 -c <commit>::
68 --reedit-message=<commit>::
69         Like '-C', but with '-c' the editor is invoked, so that
70         the user can further edit the commit message.
72 -F <file>::
73 --file=<file>::
74         Take the commit message from the given file.  Use '-' to
75         read the message from the standard input.
77 --author=<author>::
78         Override the author name used in the commit.  You can use the
79         standard `A U Thor <author@example.com>` format.  Otherwise,
80         an existing commit that matches the given string and its author
81         name is used.
83 -m <msg>::
84 --message=<msg>::
85         Use the given <msg> as the commit message.
87 -t <file>::
88 --template=<file>::
89         Use the contents of the given file as the initial version
90         of the commit message. The editor is invoked and you can
91         make subsequent changes. If a message is specified using
92         the `-m` or `-F` options, this option has no effect. This
93         overrides the `commit.template` configuration variable.
95 -s::
96 --signoff::
97         Add Signed-off-by line at the end of the commit message.
99 -n::
100 --no-verify::
101         This option bypasses the pre-commit and commit-msg hooks.
102         See also linkgit:githooks[5].
104 --allow-empty::
105         Usually recording a commit that has the exact same tree as its
106         sole parent commit is a mistake, and the command prevents you
107         from making such a commit.  This option bypasses the safety, and
108         is primarily for use by foreign scm interface scripts.
110 --cleanup=<mode>::
111         This option sets how the commit message is cleaned up.
112         The  '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
113         and 'default'. The 'default' mode will strip leading and
114         trailing empty lines and #commentary from the commit message
115         only if the message is to be edited. Otherwise only whitespace
116         removed. The 'verbatim' mode does not change message at all,
117         'whitespace' removes just leading/trailing whitespace lines
118         and 'strip' removes both whitespace and commentary.
120 -e::
121 --edit::
122         The message taken from file with `-F`, command line with
123         `-m`, and from file with `-C` are usually used as the
124         commit log message unmodified.  This option lets you
125         further edit the message taken from these sources.
127 --amend::
128         Used to amend the tip of the current branch. Prepare the tree
129         object you would want to replace the latest commit as usual
130         (this includes the usual -i/-o and explicit paths), and the
131         commit log editor is seeded with the commit message from the
132         tip of the current branch. The commit you create replaces the
133         current tip -- if it was a merge, it will have the parents of
134         the current tip as parents -- so the current top commit is
135         discarded.
138 It is a rough equivalent for:
139 ------
140         $ git reset --soft HEAD^
141         $ ... do something else to come up with the right tree ...
142         $ git commit -c ORIG_HEAD
144 ------
145 but can be used to amend a merge commit.
148 -i::
149 --include::
150         Before making a commit out of staged contents so far,
151         stage the contents of paths given on the command line
152         as well.  This is usually not what you want unless you
153         are concluding a conflicted merge.
155 -o::
156 --only::
157         Make a commit only from the paths specified on the
158         command line, disregarding any contents that have been
159         staged so far. This is the default mode of operation of
160         'git-commit' if any paths are given on the command line,
161         in which case this option can be omitted.
162         If this option is specified together with '--amend', then
163         no paths need be specified, which can be used to amend
164         the last commit without committing changes that have
165         already been staged.
167 -u[<mode>]::
168 --untracked-files[=<mode>]::
169         Show untracked files (Default: 'all').
171 The mode parameter is optional, and is used to specify
172 the handling of untracked files. The possible options are:
175         - 'no'     - Show no untracked files
176         - 'normal' - Shows untracked files and directories
177         - 'all'    - Also shows individual files in untracked directories.
180 See linkgit:git-config[1] for configuration variable
181 used to change the default for when the option is not
182 specified.
184 -v::
185 --verbose::
186         Show unified diff between the HEAD commit and what
187         would be committed at the bottom of the commit message
188         template.  Note that this diff output doesn't have its
189         lines prefixed with '#'.
191 -q::
192 --quiet::
193         Suppress commit summary message.
195 \--::
196         Do not interpret any more arguments as options.
198 <file>...::
199         When files are given on the command line, the command
200         commits the contents of the named files, without
201         recording the changes already staged.  The contents of
202         these files are also staged for the next commit on top
203         of what have been staged before.
206 EXAMPLES
207 --------
208 When recording your own work, the contents of modified files in
209 your working tree are temporarily stored to a staging area
210 called the "index" with 'git-add'.  A file can be
211 reverted back, only in the index but not in the working tree,
212 to that of the last commit with `git reset HEAD -- <file>`,
213 which effectively reverts 'git-add' and prevents the changes to
214 this file from participating in the next commit.  After building
215 the state to be committed incrementally with these commands,
216 `git commit` (without any pathname parameter) is used to record what
217 has been staged so far.  This is the most basic form of the
218 command.  An example:
220 ------------
221 $ edit hello.c
222 $ git rm goodbye.c
223 $ git add hello.c
224 $ git commit
225 ------------
227 Instead of staging files after each individual change, you can
228 tell `git commit` to notice the changes to the files whose
229 contents are tracked in
230 your working tree and do corresponding `git add` and `git rm`
231 for you.  That is, this example does the same as the earlier
232 example if there is no other change in your working tree:
234 ------------
235 $ edit hello.c
236 $ rm goodbye.c
237 $ git commit -a
238 ------------
240 The command `git commit -a` first looks at your working tree,
241 notices that you have modified hello.c and removed goodbye.c,
242 and performs necessary `git add` and `git rm` for you.
244 After staging changes to many files, you can alter the order the
245 changes are recorded in, by giving pathnames to `git commit`.
246 When pathnames are given, the command makes a commit that
247 only records the changes made to the named paths:
249 ------------
250 $ edit hello.c hello.h
251 $ git add hello.c hello.h
252 $ edit Makefile
253 $ git commit Makefile
254 ------------
256 This makes a commit that records the modification to `Makefile`.
257 The changes staged for `hello.c` and `hello.h` are not included
258 in the resulting commit.  However, their changes are not lost --
259 they are still staged and merely held back.  After the above
260 sequence, if you do:
262 ------------
263 $ git commit
264 ------------
266 this second commit would record the changes to `hello.c` and
267 `hello.h` as expected.
269 After a merge (initiated by 'git-merge' or 'git-pull') stops
270 because of conflicts, cleanly merged
271 paths are already staged to be committed for you, and paths that
272 conflicted are left in unmerged state.  You would have to first
273 check which paths are conflicting with 'git-status'
274 and after fixing them manually in your working tree, you would
275 stage the result as usual with 'git-add':
277 ------------
278 $ git status | grep unmerged
279 unmerged: hello.c
280 $ edit hello.c
281 $ git add hello.c
282 ------------
284 After resolving conflicts and staging the result, `git ls-files -u`
285 would stop mentioning the conflicted path.  When you are done,
286 run `git commit` to finally record the merge:
288 ------------
289 $ git commit
290 ------------
292 As with the case to record your own changes, you can use `-a`
293 option to save typing.  One difference is that during a merge
294 resolution, you cannot use `git commit` with pathnames to
295 alter the order the changes are committed, because the merge
296 should be recorded as a single commit.  In fact, the command
297 refuses to run when given pathnames (but see `-i` option).
300 DISCUSSION
301 ----------
303 Though not required, it's a good idea to begin the commit message
304 with a single short (less than 50 character) line summarizing the
305 change, followed by a blank line and then a more thorough description.
306 Tools that turn commits into email, for example, use the first line
307 on the Subject: line and the rest of the commit in the body.
309 include::i18n.txt[]
311 ENVIRONMENT AND CONFIGURATION VARIABLES
312 ---------------------------------------
313 The editor used to edit the commit log message will be chosen from the
314 GIT_EDITOR environment variable, the core.editor configuration variable, the
315 VISUAL environment variable, or the EDITOR environment variable (in that
316 order).
318 HOOKS
319 -----
320 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
321 and `post-commit` hooks.  See linkgit:githooks[5] for more
322 information.
325 SEE ALSO
326 --------
327 linkgit:git-add[1],
328 linkgit:git-rm[1],
329 linkgit:git-mv[1],
330 linkgit:git-merge[1],
331 linkgit:git-commit-tree[1]
333 Author
334 ------
335 Written by Linus Torvalds <torvalds@osdl.org> and
336 Junio C Hamano <gitster@pobox.com>
341 Part of the linkgit:git[1] suite