6 git-commit - Record changes to the repository
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>] [--status | --no-status]
16 [-i | -o] [-S[<keyid>]] [--] [<file>...]
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, in which
33 case the commit will ignore changes staged in the index, and instead
34 record the current content of the listed files (which must already
37 4. by using the -a switch with the 'commit' command to automatically
38 "add" changes from all known files (i.e. all files that are already
39 listed in the index) and to automatically "rm" files in the index
40 that have been removed from the working tree, and then perform the
43 5. by using the --interactive or --patch switches with the 'commit' command
44 to decide one by one which files or hunks should be part of the commit,
45 before finalizing the operation. See the ``Interactive Mode'' section of
46 linkgit:git-add[1] to learn how to operate these modes.
48 The `--dry-run` option can be used to obtain a
49 summary of what is included by any of the above for the next
50 commit by giving the same set of parameters (options and paths).
52 If you make a commit and then find a mistake immediately after
53 that, you can recover from it with 'git reset'.
60 Tell the command to automatically stage files that have
61 been modified and deleted, but new files you have not
62 told git about are not affected.
66 Use the interactive patch selection interface to chose
67 which changes to commit. See linkgit:git-add[1] for
71 --reuse-message=<commit>::
72 Take an existing commit object, and reuse the log message
73 and the authorship information (including the timestamp)
74 when creating the commit.
77 --reedit-message=<commit>::
78 Like '-C', but with '-c' the editor is invoked, so that
79 the user can further edit the commit message.
82 Construct a commit message for use with `rebase --autosquash`.
83 The commit message will be the subject line from the specified
84 commit with a prefix of "fixup! ". See linkgit:git-rebase[1]
88 Construct a commit message for use with `rebase --autosquash`.
89 The commit message subject line is taken from the specified
90 commit with a prefix of "squash! ". Can be used with additional
91 commit message options (`-m`/`-c`/`-C`/`-F`). See
92 linkgit:git-rebase[1] for details.
95 When used with -C/-c/--amend options, or when committing after a
96 a conflicting cherry-pick, declare that the authorship of the
97 resulting commit now belongs of the committer. This also renews
101 When doing a dry-run, give the output in the short-format. See
102 linkgit:git-status[1] for details. Implies `--dry-run`.
105 Show the branch and tracking info even in short-format.
108 When doing a dry-run, give the output in a porcelain-ready
109 format. See linkgit:git-status[1] for details. Implies
114 When showing `short` or `porcelain` status output, terminate
115 entries in the status output with NUL, instead of LF. If no
116 format is given, implies the `--porcelain` output format.
120 Take the commit message from the given file. Use '-' to
121 read the message from the standard input.
124 Override the commit author. Specify an explicit author using the
125 standard `A U Thor <author@example.com>` format. Otherwise <author>
126 is assumed to be a pattern and is used to search for an existing
127 commit by that author (i.e. rev-list --all -i --author=<author>);
128 the commit author is then copied from the first such commit found.
131 Override the author date used in the commit.
135 Use the given <msg> as the commit message.
139 When editing the commit message, start the editor with the
140 contents in the given file. The `commit.template` configuration
141 variable is often used to give this option implicitly to the
142 command. This mechanism can be used by projects that want to
143 guide participants with some hints on what to write in the message
144 in what order. If the user exits the editor without editing the
145 message, the commit is aborted. This has no effect when a message
146 is given by other means, e.g. with the `-m` or `-F` options.
150 Add Signed-off-by line by the committer at the end of the commit
155 This option bypasses the pre-commit and commit-msg hooks.
156 See also linkgit:githooks[5].
159 Usually recording a commit that has the exact same tree as its
160 sole parent commit is a mistake, and the command prevents you
161 from making such a commit. This option bypasses the safety, and
162 is primarily for use by foreign SCM interface scripts.
164 --allow-empty-message::
165 Like --allow-empty this command is primarily for use by foreign
166 SCM interface scripts. It allows you to create a commit with an
167 empty commit message without using plumbing commands like
168 linkgit:git-commit-tree[1].
171 This option sets how the commit message is cleaned up.
172 The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
173 and 'default'. The 'default' mode will strip leading and
174 trailing empty lines and #commentary from the commit message
175 only if the message is to be edited. Otherwise only whitespace
176 removed. The 'verbatim' mode does not change message at all,
177 'whitespace' removes just leading/trailing whitespace lines
178 and 'strip' removes both whitespace and commentary.
182 The message taken from file with `-F`, command line with
183 `-m`, and from file with `-C` are usually used as the
184 commit log message unmodified. This option lets you
185 further edit the message taken from these sources.
188 Use the selected commit message without launching an editor.
189 For example, `git commit --amend --no-edit` amends a commit
190 without changing its commit message.
193 Replace the tip of the current branch by creating a new
194 commit. The recorded tree is prepared as usual (including
195 the effect of the `-i` and `-o` options and explicit
196 pathspec), and the message from the original commit is used
197 as the starting point, instead of an empty message, when no
198 other message is specified from the command line via options
199 such as `-m`, `-F`, `-c`, etc. The new commit has the same
200 parents and author as the current one (the `--reset-author`
201 option can countermand this).
204 It is a rough equivalent for:
206 $ git reset --soft HEAD^
207 $ ... do something else to come up with the right tree ...
208 $ git commit -c ORIG_HEAD
211 but can be used to amend a merge commit.
214 You should understand the implications of rewriting history if you
215 amend a commit that has already been published. (See the "RECOVERING
216 FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
219 Bypass the post-rewrite hook.
223 Before making a commit out of staged contents so far,
224 stage the contents of paths given on the command line
225 as well. This is usually not what you want unless you
226 are concluding a conflicted merge.
230 Make a commit only from the paths specified on the
231 command line, disregarding any contents that have been
232 staged so far. This is the default mode of operation of
233 'git commit' if any paths are given on the command line,
234 in which case this option can be omitted.
235 If this option is specified together with '--amend', then
236 no paths need to be specified, which can be used to amend
237 the last commit without committing changes that have
241 --untracked-files[=<mode>]::
242 Show untracked files.
244 The mode parameter is optional (defaults to 'all'), and is used to
245 specify the handling of untracked files; when -u is not used, the
246 default is 'normal', i.e. show untracked files and directories.
248 The possible options are:
250 - 'no' - Show no untracked files
251 - 'normal' - Shows untracked files and directories
252 - 'all' - Also shows individual files in untracked directories.
254 The default can be changed using the status.showUntrackedFiles
255 configuration variable documented in linkgit:git-config[1].
259 Show unified diff between the HEAD commit and what
260 would be committed at the bottom of the commit message
261 template. Note that this diff output doesn't have its
262 lines prefixed with '#'.
266 Suppress commit summary message.
269 Do not create a commit, but show a list of paths that are
270 to be committed, paths with local changes that will be left
271 uncommitted and paths that are untracked.
274 Include the output of linkgit:git-status[1] in the commit
275 message template when using an editor to prepare the commit
276 message. Defaults to on, but can be used to override
277 configuration variable commit.status.
280 Do not include the output of linkgit:git-status[1] in the
281 commit message template when using an editor to prepare the
282 default commit message.
285 --gpg-sign[=<keyid>]::
289 Do not interpret any more arguments as options.
292 When files are given on the command line, the command
293 commits the contents of the named files, without
294 recording the changes already staged. The contents of
295 these files are also staged for the next commit on top
296 of what have been staged before.
299 include::date-formats.txt[]
303 When recording your own work, the contents of modified files in
304 your working tree are temporarily stored to a staging area
305 called the "index" with 'git add'. A file can be
306 reverted back, only in the index but not in the working tree,
307 to that of the last commit with `git reset HEAD -- <file>`,
308 which effectively reverts 'git add' and prevents the changes to
309 this file from participating in the next commit. After building
310 the state to be committed incrementally with these commands,
311 `git commit` (without any pathname parameter) is used to record what
312 has been staged so far. This is the most basic form of the
322 Instead of staging files after each individual change, you can
323 tell `git commit` to notice the changes to the files whose
324 contents are tracked in
325 your working tree and do corresponding `git add` and `git rm`
326 for you. That is, this example does the same as the earlier
327 example if there is no other change in your working tree:
335 The command `git commit -a` first looks at your working tree,
336 notices that you have modified hello.c and removed goodbye.c,
337 and performs necessary `git add` and `git rm` for you.
339 After staging changes to many files, you can alter the order the
340 changes are recorded in, by giving pathnames to `git commit`.
341 When pathnames are given, the command makes a commit that
342 only records the changes made to the named paths:
345 $ edit hello.c hello.h
346 $ git add hello.c hello.h
348 $ git commit Makefile
351 This makes a commit that records the modification to `Makefile`.
352 The changes staged for `hello.c` and `hello.h` are not included
353 in the resulting commit. However, their changes are not lost --
354 they are still staged and merely held back. After the above
361 this second commit would record the changes to `hello.c` and
362 `hello.h` as expected.
364 After a merge (initiated by 'git merge' or 'git pull') stops
365 because of conflicts, cleanly merged
366 paths are already staged to be committed for you, and paths that
367 conflicted are left in unmerged state. You would have to first
368 check which paths are conflicting with 'git status'
369 and after fixing them manually in your working tree, you would
370 stage the result as usual with 'git add':
373 $ git status | grep unmerged
379 After resolving conflicts and staging the result, `git ls-files -u`
380 would stop mentioning the conflicted path. When you are done,
381 run `git commit` to finally record the merge:
387 As with the case to record your own changes, you can use `-a`
388 option to save typing. One difference is that during a merge
389 resolution, you cannot use `git commit` with pathnames to
390 alter the order the changes are committed, because the merge
391 should be recorded as a single commit. In fact, the command
392 refuses to run when given pathnames (but see `-i` option).
398 Though not required, it's a good idea to begin the commit message
399 with a single short (less than 50 character) line summarizing the
400 change, followed by a blank line and then a more thorough description.
401 The text up to the first blank line in a commit message is treated
402 as the commit title, and that title is used throughout git.
403 For example, linkgit:git-format-patch[1] turns a commit into email, and it uses
404 the title on the Subject line and the rest of the commit in the body.
408 ENVIRONMENT AND CONFIGURATION VARIABLES
409 ---------------------------------------
410 The editor used to edit the commit log message will be chosen from the
411 GIT_EDITOR environment variable, the core.editor configuration variable, the
412 VISUAL environment variable, or the EDITOR environment variable (in that
413 order). See linkgit:git-var[1] for details.
417 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
418 and `post-commit` hooks. See linkgit:githooks[5] for more
424 `$GIT_DIR/COMMIT_EDITMSG`::
425 This file contains the commit message of a commit in progress.
426 If `git commit` exits due to an error before creating a commit,
427 any commit message that has been provided by the user (e.g., in
428 an editor session) will be available in this file, but will be
429 overwritten by the next invocation of `git commit`.
436 linkgit:git-merge[1],
437 linkgit:git-commit-tree[1]
441 Part of the linkgit:git[1] suite