6 git-commit - Record changes to the repository
11 'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
12 [(-c | -C | --fixup | --squash) <commit>] [-F <file> | -m <msg>]
13 [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify]
14 [-e] [--author=<author>] [--date=<date>] [--cleanup=<mode>]
15 [--status | --no-status] [-i | -o] [--] [<file>...]
19 Stores the current contents of the index in a new commit along
20 with a log message from the user describing the changes.
22 The content to be added can be specified in several ways:
24 1. by using 'git add' to incrementally "add" changes to the
25 index before using the 'commit' command (Note: even modified
26 files must be "added");
28 2. by using 'git rm' to remove files from the working tree
29 and the index, again before using the 'commit' command;
31 3. by listing files as arguments to the 'commit' command, in which
32 case the commit will ignore changes staged in the index, and instead
33 record the current content of the listed files (which must already
36 4. by using the -a switch with the 'commit' command to automatically
37 "add" changes from all known files (i.e. all files that are already
38 listed in the index) and to automatically "rm" files in the index
39 that have been removed from the working tree, and then perform the
42 5. by using the --interactive switch with the 'commit' command to decide one
43 by one which files should be part of the commit, before finalizing the
44 operation. Currently, this is done by invoking 'git add --interactive'.
46 The `--dry-run` option can be used to obtain a
47 summary of what is included by any of the above for the next
48 commit by giving the same set of parameters (options and paths).
50 If you make a commit and then find a mistake immediately after
51 that, you can recover from it with 'git reset'.
58 Tell the command to automatically stage files that have
59 been modified and deleted, but new files you have not
60 told git about are not affected.
63 --reuse-message=<commit>::
64 Take an existing commit object, and reuse the log message
65 and the authorship information (including the timestamp)
66 when creating the commit.
69 --reedit-message=<commit>::
70 Like '-C', but with '-c' the editor is invoked, so that
71 the user can further edit the commit message.
74 Construct a commit message for use with `rebase --autosquash`.
75 The commit message will be the subject line from the specified
76 commit with a prefix of "fixup! ". See linkgit:git-rebase[1]
80 Construct a commit message for use with `rebase --autosquash`.
81 The commit message subject line is taken from the specified
82 commit with a prefix of "squash! ". Can be used with additional
83 commit message options (`-m`/`-c`/`-C`/`-F`). See
84 linkgit:git-rebase[1] for details.
87 When used with -C/-c/--amend options, declare that the
88 authorship of the resulting commit now belongs of the committer.
89 This also renews the author timestamp.
92 When doing a dry-run, give the output in the short-format. See
93 linkgit:git-status[1] for details. Implies `--dry-run`.
96 When doing a dry-run, give the output in a porcelain-ready
97 format. See linkgit:git-status[1] for details. Implies
101 When showing `short` or `porcelain` status output, terminate
102 entries in the status output with NUL, instead of LF. If no
103 format is given, implies the `--porcelain` output format.
107 Take the commit message from the given file. Use '-' to
108 read the message from the standard input.
111 Override the commit author. Specify an explicit author using the
112 standard `A U Thor <author@example.com>` format. Otherwise <author>
113 is assumed to be a pattern and is used to search for an existing
114 commit by that author (i.e. rev-list --all -i --author=<author>);
115 the commit author is then copied from the first such commit found.
118 Override the author date used in the commit.
122 Use the given <msg> as the commit message.
126 Use the contents of the given file as the initial version
127 of the commit message. The editor is invoked and you can
128 make subsequent changes. If a message is specified using
129 the `-m` or `-F` options, this option has no effect. This
130 overrides the `commit.template` configuration variable.
134 Add Signed-off-by line by the committer at the end of the commit
139 This option bypasses the pre-commit and commit-msg hooks.
140 See also linkgit:githooks[5].
143 Usually recording a commit that has the exact same tree as its
144 sole parent commit is a mistake, and the command prevents you
145 from making such a commit. This option bypasses the safety, and
146 is primarily for use by foreign SCM interface scripts.
148 --allow-empty-message::
149 Like --allow-empty this command is primarily for use by foreign
150 SCM interface scripts. It allows you to create a commit with an
151 empty commit message without using plumbing commands like
152 linkgit:git-commit-tree[1].
155 This option sets how the commit message is cleaned up.
156 The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
157 and 'default'. The 'default' mode will strip leading and
158 trailing empty lines and #commentary from the commit message
159 only if the message is to be edited. Otherwise only whitespace
160 removed. The 'verbatim' mode does not change message at all,
161 'whitespace' removes just leading/trailing whitespace lines
162 and 'strip' removes both whitespace and commentary.
166 The message taken from file with `-F`, command line with
167 `-m`, and from file with `-C` are usually used as the
168 commit log message unmodified. This option lets you
169 further edit the message taken from these sources.
172 Used to amend the tip of the current branch. Prepare the tree
173 object you would want to replace the latest commit as usual
174 (this includes the usual -i/-o and explicit paths), and the
175 commit log editor is seeded with the commit message from the
176 tip of the current branch. The commit you create replaces the
177 current tip -- if it was a merge, it will have the parents of
178 the current tip as parents -- so the current top commit is
182 It is a rough equivalent for:
184 $ git reset --soft HEAD^
185 $ ... do something else to come up with the right tree ...
186 $ git commit -c ORIG_HEAD
189 but can be used to amend a merge commit.
192 You should understand the implications of rewriting history if you
193 amend a commit that has already been published. (See the "RECOVERING
194 FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
198 Before making a commit out of staged contents so far,
199 stage the contents of paths given on the command line
200 as well. This is usually not what you want unless you
201 are concluding a conflicted merge.
205 Make a commit only from the paths specified on the
206 command line, disregarding any contents that have been
207 staged so far. This is the default mode of operation of
208 'git commit' if any paths are given on the command line,
209 in which case this option can be omitted.
210 If this option is specified together with '--amend', then
211 no paths need to be specified, which can be used to amend
212 the last commit without committing changes that have
216 --untracked-files[=<mode>]::
217 Show untracked files.
219 The mode parameter is optional (defaults to 'all'), and is used to
220 specify the handling of untracked files; when -u is not used, the
221 default is 'normal', i.e. show untracked files and directories.
223 The possible options are:
225 - 'no' - Show no untracked files
226 - 'normal' - Shows untracked files and directories
227 - 'all' - Also shows individual files in untracked directories.
229 The default can be changed using the status.showUntrackedFiles
230 configuration variable documented in linkgit:git-config[1].
234 Show unified diff between the HEAD commit and what
235 would be committed at the bottom of the commit message
236 template. Note that this diff output doesn't have its
237 lines prefixed with '#'.
241 Suppress commit summary message.
244 Do not create a commit, but show a list of paths that are
245 to be committed, paths with local changes that will be left
246 uncommitted and paths that are untracked.
249 Include the output of linkgit:git-status[1] in the commit
250 message template when using an editor to prepare the commit
251 message. Defaults to on, but can be used to override
252 configuration variable commit.status.
255 Do not include the output of linkgit:git-status[1] in the
256 commit message template when using an editor to prepare the
257 default commit message.
260 Do not interpret any more arguments as options.
263 When files are given on the command line, the command
264 commits the contents of the named files, without
265 recording the changes already staged. The contents of
266 these files are also staged for the next commit on top
267 of what have been staged before.
270 include::date-formats.txt[]
274 When recording your own work, the contents of modified files in
275 your working tree are temporarily stored to a staging area
276 called the "index" with 'git add'. A file can be
277 reverted back, only in the index but not in the working tree,
278 to that of the last commit with `git reset HEAD \-- <file>`,
279 which effectively reverts 'git add' and prevents the changes to
280 this file from participating in the next commit. After building
281 the state to be committed incrementally with these commands,
282 `git commit` (without any pathname parameter) is used to record what
283 has been staged so far. This is the most basic form of the
293 Instead of staging files after each individual change, you can
294 tell `git commit` to notice the changes to the files whose
295 contents are tracked in
296 your working tree and do corresponding `git add` and `git rm`
297 for you. That is, this example does the same as the earlier
298 example if there is no other change in your working tree:
306 The command `git commit -a` first looks at your working tree,
307 notices that you have modified hello.c and removed goodbye.c,
308 and performs necessary `git add` and `git rm` for you.
310 After staging changes to many files, you can alter the order the
311 changes are recorded in, by giving pathnames to `git commit`.
312 When pathnames are given, the command makes a commit that
313 only records the changes made to the named paths:
316 $ edit hello.c hello.h
317 $ git add hello.c hello.h
319 $ git commit Makefile
322 This makes a commit that records the modification to `Makefile`.
323 The changes staged for `hello.c` and `hello.h` are not included
324 in the resulting commit. However, their changes are not lost --
325 they are still staged and merely held back. After the above
332 this second commit would record the changes to `hello.c` and
333 `hello.h` as expected.
335 After a merge (initiated by 'git merge' or 'git pull') stops
336 because of conflicts, cleanly merged
337 paths are already staged to be committed for you, and paths that
338 conflicted are left in unmerged state. You would have to first
339 check which paths are conflicting with 'git status'
340 and after fixing them manually in your working tree, you would
341 stage the result as usual with 'git add':
344 $ git status | grep unmerged
350 After resolving conflicts and staging the result, `git ls-files -u`
351 would stop mentioning the conflicted path. When you are done,
352 run `git commit` to finally record the merge:
358 As with the case to record your own changes, you can use `-a`
359 option to save typing. One difference is that during a merge
360 resolution, you cannot use `git commit` with pathnames to
361 alter the order the changes are committed, because the merge
362 should be recorded as a single commit. In fact, the command
363 refuses to run when given pathnames (but see `-i` option).
369 Though not required, it's a good idea to begin the commit message
370 with a single short (less than 50 character) line summarizing the
371 change, followed by a blank line and then a more thorough description.
372 Tools that turn commits into email, for example, use the first line
373 on the Subject: line and the rest of the commit in the body.
377 ENVIRONMENT AND CONFIGURATION VARIABLES
378 ---------------------------------------
379 The editor used to edit the commit log message will be chosen from the
380 GIT_EDITOR environment variable, the core.editor configuration variable, the
381 VISUAL environment variable, or the EDITOR environment variable (in that
382 order). See linkgit:git-var[1] for details.
386 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
387 and `post-commit` hooks. See linkgit:githooks[5] for more
396 linkgit:git-merge[1],
397 linkgit:git-commit-tree[1]
401 Written by Linus Torvalds <torvalds@osdl.org> and
402 Junio C Hamano <gitster@pobox.com>
407 Part of the linkgit:git[1] suite