commit doc: document that -c, -C, -F and --fixup with -m error
[git.git] / Documentation / git-commit.txt
blob3fbb7352bc77840a29d9955430f1ff9ceba7f9a0
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 | --patch] [-s] [-v] [-u<mode>] [--amend]
12            [--dry-run] [(-c | -C | --fixup | --squash) <commit>]
13            [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
14            [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
15            [--date=<date>] [--cleanup=<mode>] [--[no-]status]
16            [-i | -o] [-S[<keyid>]] [--] [<file>...]
18 DESCRIPTION
19 -----------
20 Stores the current contents of the index in a new commit along
21 with a log message from the user describing the changes.
23 The content to be added can be specified in several ways:
25 1. by using 'git add' to incrementally "add" changes to the
26    index before using the 'commit' command (Note: even modified
27    files must be "added");
29 2. by using 'git rm' to remove files from the working tree
30    and the index, again before using the 'commit' command;
32 3. by listing files as arguments to the 'commit' command
33    (without --interactive or --patch switch), in which
34    case the commit will ignore changes staged in the index, and instead
35    record the current content of the listed files (which must already
36    be known to Git);
38 4. by using the -a switch with the 'commit' command to automatically
39    "add" changes from all known files (i.e. all files that are already
40    listed in the index) and to automatically "rm" files in the index
41    that have been removed from the working tree, and then perform the
42    actual commit;
44 5. by using the --interactive or --patch switches with the 'commit' command
45    to decide one by one which files or hunks should be part of the commit
46    in addition to contents in the index,
47    before finalizing the operation. See the ``Interactive Mode'' section of
48    linkgit:git-add[1] to learn how to operate these modes.
50 The `--dry-run` option can be used to obtain a
51 summary of what is included by any of the above for the next
52 commit by giving the same set of parameters (options and paths).
54 If you make a commit and then find a mistake immediately after
55 that, you can recover from it with 'git reset'.
58 OPTIONS
59 -------
60 -a::
61 --all::
62         Tell the command to automatically stage files that have
63         been modified and deleted, but new files you have not
64         told Git about are not affected.
66 -p::
67 --patch::
68         Use the interactive patch selection interface to chose
69         which changes to commit. See linkgit:git-add[1] for
70         details.
72 -C <commit>::
73 --reuse-message=<commit>::
74         Take an existing commit object, and reuse the log message
75         and the authorship information (including the timestamp)
76         when creating the commit.
78 -c <commit>::
79 --reedit-message=<commit>::
80         Like '-C', but with `-c` the editor is invoked, so that
81         the user can further edit the commit message.
83 --fixup=<commit>::
84         Construct a commit message for use with `rebase --autosquash`.
85         The commit message will be the subject line from the specified
86         commit with a prefix of "fixup! ".  See linkgit:git-rebase[1]
87         for details.
89 --squash=<commit>::
90         Construct a commit message for use with `rebase --autosquash`.
91         The commit message subject line is taken from the specified
92         commit with a prefix of "squash! ".  Can be used with additional
93         commit message options (`-m`/`-c`/`-C`/`-F`). See
94         linkgit:git-rebase[1] for details.
96 --reset-author::
97         When used with -C/-c/--amend options, or when committing after a
98         conflicting cherry-pick, declare that the authorship of the
99         resulting commit now belongs to the committer. This also renews
100         the author timestamp.
102 --short::
103         When doing a dry-run, give the output in the short-format. See
104         linkgit:git-status[1] for details. Implies `--dry-run`.
106 --branch::
107         Show the branch and tracking info even in short-format.
109 --porcelain::
110         When doing a dry-run, give the output in a porcelain-ready
111         format. See linkgit:git-status[1] for details. Implies
112         `--dry-run`.
114 --long::
115         When doing a dry-run, give the output in the long-format.
116         Implies `--dry-run`.
118 -z::
119 --null::
120         When showing `short` or `porcelain` status output, print the
121         filename verbatim and terminate the entries with NUL, instead of LF.
122         If no format is given, implies the `--porcelain` output format.
123         Without the `-z` option, filenames with "unusual" characters are
124         quoted as explained for the configuration variable `core.quotePath`
125         (see linkgit:git-config[1]).
127 -F <file>::
128 --file=<file>::
129         Take the commit message from the given file.  Use '-' to
130         read the message from the standard input.
132 --author=<author>::
133         Override the commit author. Specify an explicit author using the
134         standard `A U Thor <author@example.com>` format. Otherwise <author>
135         is assumed to be a pattern and is used to search for an existing
136         commit by that author (i.e. rev-list --all -i --author=<author>);
137         the commit author is then copied from the first such commit found.
139 --date=<date>::
140         Override the author date used in the commit.
142 -m <msg>::
143 --message=<msg>::
144         Use the given <msg> as the commit message.
145         If multiple `-m` options are given, their values are
146         concatenated as separate paragraphs.
148 The `-m` option is mutually exclusive with `-c`, `-C`, `-F`, and
149 `--fixup`.
151 -t <file>::
152 --template=<file>::
153         When editing the commit message, start the editor with the
154         contents in the given file.  The `commit.template` configuration
155         variable is often used to give this option implicitly to the
156         command.  This mechanism can be used by projects that want to
157         guide participants with some hints on what to write in the message
158         in what order.  If the user exits the editor without editing the
159         message, the commit is aborted.  This has no effect when a message
160         is given by other means, e.g. with the `-m` or `-F` options.
162 -s::
163 --signoff::
164         Add Signed-off-by line by the committer at the end of the commit
165         log message.  The meaning of a signoff depends on the project,
166         but it typically certifies that committer has
167         the rights to submit this work under the same license and
168         agrees to a Developer Certificate of Origin
169         (see http://developercertificate.org/ for more information).
171 -n::
172 --no-verify::
173         This option bypasses the pre-commit and commit-msg hooks.
174         See also linkgit:githooks[5].
176 --allow-empty::
177         Usually recording a commit that has the exact same tree as its
178         sole parent commit is a mistake, and the command prevents you
179         from making such a commit.  This option bypasses the safety, and
180         is primarily for use by foreign SCM interface scripts.
182 --allow-empty-message::
183        Like --allow-empty this command is primarily for use by foreign
184        SCM interface scripts. It allows you to create a commit with an
185        empty commit message without using plumbing commands like
186        linkgit:git-commit-tree[1].
188 --cleanup=<mode>::
189         This option determines how the supplied commit message should be
190         cleaned up before committing.  The '<mode>' can be `strip`,
191         `whitespace`, `verbatim`, `scissors` or `default`.
194 strip::
195         Strip leading and trailing empty lines, trailing whitespace,
196         commentary and collapse consecutive empty lines.
197 whitespace::
198         Same as `strip` except #commentary is not removed.
199 verbatim::
200         Do not change the message at all.
201 scissors::
202         Same as `whitespace` except that everything from (and including)
203         the line found below is truncated, if the message is to be edited.
204         "`#`" can be customized with core.commentChar.
206                 # ------------------------ >8 ------------------------
208 default::
209         Same as `strip` if the message is to be edited.
210         Otherwise `whitespace`.
213 The default can be changed by the `commit.cleanup` configuration
214 variable (see linkgit:git-config[1]).
216 -e::
217 --edit::
218         The message taken from file with `-F`, command line with
219         `-m`, and from commit object with `-C` are usually used as
220         the commit log message unmodified. This option lets you
221         further edit the message taken from these sources.
223 --no-edit::
224         Use the selected commit message without launching an editor.
225         For example, `git commit --amend --no-edit` amends a commit
226         without changing its commit message.
228 --amend::
229         Replace the tip of the current branch by creating a new
230         commit. The recorded tree is prepared as usual (including
231         the effect of the `-i` and `-o` options and explicit
232         pathspec), and the message from the original commit is used
233         as the starting point, instead of an empty message, when no
234         other message is specified from the command line via options
235         such as `-m`, `-F`, `-c`, etc.  The new commit has the same
236         parents and author as the current one (the `--reset-author`
237         option can countermand this).
240 It is a rough equivalent for:
241 ------
242         $ git reset --soft HEAD^
243         $ ... do something else to come up with the right tree ...
244         $ git commit -c ORIG_HEAD
246 ------
247 but can be used to amend a merge commit.
250 You should understand the implications of rewriting history if you
251 amend a commit that has already been published.  (See the "RECOVERING
252 FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
254 --no-post-rewrite::
255         Bypass the post-rewrite hook.
257 -i::
258 --include::
259         Before making a commit out of staged contents so far,
260         stage the contents of paths given on the command line
261         as well.  This is usually not what you want unless you
262         are concluding a conflicted merge.
264 -o::
265 --only::
266         Make a commit by taking the updated working tree contents
267         of the paths specified on the
268         command line, disregarding any contents that have been
269         staged for other paths. This is the default mode of operation of
270         'git commit' if any paths are given on the command line,
271         in which case this option can be omitted.
272         If this option is specified together with `--amend`, then
273         no paths need to be specified, which can be used to amend
274         the last commit without committing changes that have
275         already been staged. If used together with `--allow-empty`
276         paths are also not required, and an empty commit will be created.
278 -u[<mode>]::
279 --untracked-files[=<mode>]::
280         Show untracked files.
282 The mode parameter is optional (defaults to 'all'), and is used to
283 specify the handling of untracked files; when -u is not used, the
284 default is 'normal', i.e. show untracked files and directories.
286 The possible options are:
288         - 'no'     - Show no untracked files
289         - 'normal' - Shows untracked files and directories
290         - 'all'    - Also shows individual files in untracked directories.
292 The default can be changed using the status.showUntrackedFiles
293 configuration variable documented in linkgit:git-config[1].
295 -v::
296 --verbose::
297         Show unified diff between the HEAD commit and what
298         would be committed at the bottom of the commit message
299         template to help the user describe the commit by reminding
300         what changes the commit has.
301         Note that this diff output doesn't have its
302         lines prefixed with '#'. This diff will not be a part
303         of the commit message. See the `commit.verbose` configuration
304         variable in linkgit:git-config[1].
306 If specified twice, show in addition the unified diff between
307 what would be committed and the worktree files, i.e. the unstaged
308 changes to tracked files.
310 -q::
311 --quiet::
312         Suppress commit summary message.
314 --dry-run::
315         Do not create a commit, but show a list of paths that are
316         to be committed, paths with local changes that will be left
317         uncommitted and paths that are untracked.
319 --status::
320         Include the output of linkgit:git-status[1] in the commit
321         message template when using an editor to prepare the commit
322         message.  Defaults to on, but can be used to override
323         configuration variable commit.status.
325 --no-status::
326         Do not include the output of linkgit:git-status[1] in the
327         commit message template when using an editor to prepare the
328         default commit message.
330 -S[<keyid>]::
331 --gpg-sign[=<keyid>]::
332         GPG-sign commits. The `keyid` argument is optional and
333         defaults to the committer identity; if specified, it must be
334         stuck to the option without a space.
336 --no-gpg-sign::
337         Countermand `commit.gpgSign` configuration variable that is
338         set to force each and every commit to be signed.
340 \--::
341         Do not interpret any more arguments as options.
343 <file>...::
344         When files are given on the command line, the command
345         commits the contents of the named files, without
346         recording the changes already staged.  The contents of
347         these files are also staged for the next commit on top
348         of what have been staged before.
350 :git-commit: 1
351 include::date-formats.txt[]
353 EXAMPLES
354 --------
355 When recording your own work, the contents of modified files in
356 your working tree are temporarily stored to a staging area
357 called the "index" with 'git add'.  A file can be
358 reverted back, only in the index but not in the working tree,
359 to that of the last commit with `git reset HEAD -- <file>`,
360 which effectively reverts 'git add' and prevents the changes to
361 this file from participating in the next commit.  After building
362 the state to be committed incrementally with these commands,
363 `git commit` (without any pathname parameter) is used to record what
364 has been staged so far.  This is the most basic form of the
365 command.  An example:
367 ------------
368 $ edit hello.c
369 $ git rm goodbye.c
370 $ git add hello.c
371 $ git commit
372 ------------
374 Instead of staging files after each individual change, you can
375 tell `git commit` to notice the changes to the files whose
376 contents are tracked in
377 your working tree and do corresponding `git add` and `git rm`
378 for you.  That is, this example does the same as the earlier
379 example if there is no other change in your working tree:
381 ------------
382 $ edit hello.c
383 $ rm goodbye.c
384 $ git commit -a
385 ------------
387 The command `git commit -a` first looks at your working tree,
388 notices that you have modified hello.c and removed goodbye.c,
389 and performs necessary `git add` and `git rm` for you.
391 After staging changes to many files, you can alter the order the
392 changes are recorded in, by giving pathnames to `git commit`.
393 When pathnames are given, the command makes a commit that
394 only records the changes made to the named paths:
396 ------------
397 $ edit hello.c hello.h
398 $ git add hello.c hello.h
399 $ edit Makefile
400 $ git commit Makefile
401 ------------
403 This makes a commit that records the modification to `Makefile`.
404 The changes staged for `hello.c` and `hello.h` are not included
405 in the resulting commit.  However, their changes are not lost --
406 they are still staged and merely held back.  After the above
407 sequence, if you do:
409 ------------
410 $ git commit
411 ------------
413 this second commit would record the changes to `hello.c` and
414 `hello.h` as expected.
416 After a merge (initiated by 'git merge' or 'git pull') stops
417 because of conflicts, cleanly merged
418 paths are already staged to be committed for you, and paths that
419 conflicted are left in unmerged state.  You would have to first
420 check which paths are conflicting with 'git status'
421 and after fixing them manually in your working tree, you would
422 stage the result as usual with 'git add':
424 ------------
425 $ git status | grep unmerged
426 unmerged: hello.c
427 $ edit hello.c
428 $ git add hello.c
429 ------------
431 After resolving conflicts and staging the result, `git ls-files -u`
432 would stop mentioning the conflicted path.  When you are done,
433 run `git commit` to finally record the merge:
435 ------------
436 $ git commit
437 ------------
439 As with the case to record your own changes, you can use `-a`
440 option to save typing.  One difference is that during a merge
441 resolution, you cannot use `git commit` with pathnames to
442 alter the order the changes are committed, because the merge
443 should be recorded as a single commit.  In fact, the command
444 refuses to run when given pathnames (but see `-i` option).
447 DISCUSSION
448 ----------
450 Though not required, it's a good idea to begin the commit message
451 with a single short (less than 50 character) line summarizing the
452 change, followed by a blank line and then a more thorough description.
453 The text up to the first blank line in a commit message is treated
454 as the commit title, and that title is used throughout Git.
455 For example, linkgit:git-format-patch[1] turns a commit into email, and it uses
456 the title on the Subject line and the rest of the commit in the body.
458 include::i18n.txt[]
460 ENVIRONMENT AND CONFIGURATION VARIABLES
461 ---------------------------------------
462 The editor used to edit the commit log message will be chosen from the
463 `GIT_EDITOR` environment variable, the core.editor configuration variable, the
464 `VISUAL` environment variable, or the `EDITOR` environment variable (in that
465 order).  See linkgit:git-var[1] for details.
467 HOOKS
468 -----
469 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
470 `post-commit` and `post-rewrite` hooks.  See linkgit:githooks[5] for more
471 information.
473 FILES
474 -----
476 `$GIT_DIR/COMMIT_EDITMSG`::
477         This file contains the commit message of a commit in progress.
478         If `git commit` exits due to an error before creating a commit,
479         any commit message that has been provided by the user (e.g., in
480         an editor session) will be available in this file, but will be
481         overwritten by the next invocation of `git commit`.
483 SEE ALSO
484 --------
485 linkgit:git-add[1],
486 linkgit:git-rm[1],
487 linkgit:git-mv[1],
488 linkgit:git-merge[1],
489 linkgit:git-commit-tree[1]
493 Part of the linkgit:git[1] suite