6 git-commit - Record changes to the repository
11 'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
12 [(-c | -C) <commit>] [-F <file> | -m <msg>]
13 [--allow-empty] [--no-verify] [-e] [--author=<author>]
14 [--cleanup=<mode>] [--] [[-i | -o ]<file>...]
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 (which must already
35 4. by using the -a switch with the 'commit' command to automatically
36 "add" changes from all known files (i.e. all files that are already
37 listed in the index) and to automatically "rm" files in the index
38 that have been removed from the working tree, and then perform the
41 5. by using the --interactive switch with the 'commit' command to decide one
42 by one which files should be part of the commit, before finalizing the
43 operation. Currently, this is done by invoking 'git-add --interactive'.
45 The `--dry-run` option can be used to obtain a
46 summary of what is included by any of the above for the next
47 commit by giving the same set of parameters (options and paths).
49 If you make a commit and then find a mistake immediately after
50 that, you can recover from it with 'git-reset'.
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.
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.
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.
73 When doing a dry-run, give the output in the short-format. See
74 linkgit:git-status[1] for details. Implies `--dry-run`.
77 When doing a dry-run, give the output in a porcelain-ready
78 format. See linkgit:git-status[1] for details. Implies
82 When showing `short` or `porcelain` status output, terminate
83 entries in the status output with NUL, instead of LF. If no
84 format is given, implies the `--porcelain` output format.
88 Take the commit message from the given file. Use '-' to
89 read the message from the standard input.
92 Override the author name used in the commit. You can use the
93 standard `A U Thor <author@example.com>` format. Otherwise,
94 an existing commit that matches the given string and its author
99 Use the given <msg> as the commit message.
103 Use the contents of the given file as the initial version
104 of the commit message. The editor is invoked and you can
105 make subsequent changes. If a message is specified using
106 the `-m` or `-F` options, this option has no effect. This
107 overrides the `commit.template` configuration variable.
111 Add Signed-off-by line by the committer at the end of the commit
116 This option bypasses the pre-commit and commit-msg hooks.
117 See also linkgit:githooks[5].
120 Usually recording a commit that has the exact same tree as its
121 sole parent commit is a mistake, and the command prevents you
122 from making such a commit. This option bypasses the safety, and
123 is primarily for use by foreign scm interface scripts.
126 This option sets how the commit message is cleaned up.
127 The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
128 and 'default'. The 'default' mode will strip leading and
129 trailing empty lines and #commentary from the commit message
130 only if the message is to be edited. Otherwise only whitespace
131 removed. The 'verbatim' mode does not change message at all,
132 'whitespace' removes just leading/trailing whitespace lines
133 and 'strip' removes both whitespace and commentary.
137 The message taken from file with `-F`, command line with
138 `-m`, and from file with `-C` are usually used as the
139 commit log message unmodified. This option lets you
140 further edit the message taken from these sources.
143 Used to amend the tip of the current branch. Prepare the tree
144 object you would want to replace the latest commit as usual
145 (this includes the usual -i/-o and explicit paths), and the
146 commit log editor is seeded with the commit message from the
147 tip of the current branch. The commit you create replaces the
148 current tip -- if it was a merge, it will have the parents of
149 the current tip as parents -- so the current top commit is
153 It is a rough equivalent for:
155 $ git reset --soft HEAD^
156 $ ... do something else to come up with the right tree ...
157 $ git commit -c ORIG_HEAD
160 but can be used to amend a merge commit.
163 You should understand the implications of rewriting history if you
164 amend a commit that has already been published. (See the "RECOVERING
165 FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
169 Before making a commit out of staged contents so far,
170 stage the contents of paths given on the command line
171 as well. This is usually not what you want unless you
172 are concluding a conflicted merge.
176 Make a commit only from the paths specified on the
177 command line, disregarding any contents that have been
178 staged so far. This is the default mode of operation of
179 'git-commit' if any paths are given on the command line,
180 in which case this option can be omitted.
181 If this option is specified together with '--amend', then
182 no paths need to be specified, which can be used to amend
183 the last commit without committing changes that have
187 --untracked-files[=<mode>]::
188 Show untracked files (Default: 'all').
190 The mode parameter is optional, and is used to specify
191 the handling of untracked files. The possible options are:
194 - 'no' - Show no untracked files
195 - 'normal' - Shows untracked files and directories
196 - 'all' - Also shows individual files in untracked directories.
199 See linkgit:git-config[1] for configuration variable
200 used to change the default for when the option is not
205 Show unified diff between the HEAD commit and what
206 would be committed at the bottom of the commit message
207 template. Note that this diff output doesn't have its
208 lines prefixed with '#'.
212 Suppress commit summary message.
215 Do not create a commit, but show a list of paths that are
216 to be committed, paths with local changes that will be left
217 uncommitted and paths that are untracked.
220 Do not interpret any more arguments as options.
223 When files are given on the command line, the command
224 commits the contents of the named files, without
225 recording the changes already staged. The contents of
226 these files are also staged for the next commit on top
227 of what have been staged before.
232 When recording your own work, the contents of modified files in
233 your working tree are temporarily stored to a staging area
234 called the "index" with 'git-add'. A file can be
235 reverted back, only in the index but not in the working tree,
236 to that of the last commit with `git reset HEAD -- <file>`,
237 which effectively reverts 'git-add' and prevents the changes to
238 this file from participating in the next commit. After building
239 the state to be committed incrementally with these commands,
240 `git commit` (without any pathname parameter) is used to record what
241 has been staged so far. This is the most basic form of the
251 Instead of staging files after each individual change, you can
252 tell `git commit` to notice the changes to the files whose
253 contents are tracked in
254 your working tree and do corresponding `git add` and `git rm`
255 for you. That is, this example does the same as the earlier
256 example if there is no other change in your working tree:
264 The command `git commit -a` first looks at your working tree,
265 notices that you have modified hello.c and removed goodbye.c,
266 and performs necessary `git add` and `git rm` for you.
268 After staging changes to many files, you can alter the order the
269 changes are recorded in, by giving pathnames to `git commit`.
270 When pathnames are given, the command makes a commit that
271 only records the changes made to the named paths:
274 $ edit hello.c hello.h
275 $ git add hello.c hello.h
277 $ git commit Makefile
280 This makes a commit that records the modification to `Makefile`.
281 The changes staged for `hello.c` and `hello.h` are not included
282 in the resulting commit. However, their changes are not lost --
283 they are still staged and merely held back. After the above
290 this second commit would record the changes to `hello.c` and
291 `hello.h` as expected.
293 After a merge (initiated by 'git-merge' or 'git-pull') stops
294 because of conflicts, cleanly merged
295 paths are already staged to be committed for you, and paths that
296 conflicted are left in unmerged state. You would have to first
297 check which paths are conflicting with 'git-status'
298 and after fixing them manually in your working tree, you would
299 stage the result as usual with 'git-add':
302 $ git status | grep unmerged
308 After resolving conflicts and staging the result, `git ls-files -u`
309 would stop mentioning the conflicted path. When you are done,
310 run `git commit` to finally record the merge:
316 As with the case to record your own changes, you can use `-a`
317 option to save typing. One difference is that during a merge
318 resolution, you cannot use `git commit` with pathnames to
319 alter the order the changes are committed, because the merge
320 should be recorded as a single commit. In fact, the command
321 refuses to run when given pathnames (but see `-i` option).
327 Though not required, it's a good idea to begin the commit message
328 with a single short (less than 50 character) line summarizing the
329 change, followed by a blank line and then a more thorough description.
330 Tools that turn commits into email, for example, use the first line
331 on the Subject: line and the rest of the commit in the body.
335 ENVIRONMENT AND CONFIGURATION VARIABLES
336 ---------------------------------------
337 The editor used to edit the commit log message will be chosen from the
338 GIT_EDITOR environment variable, the core.editor configuration variable, the
339 VISUAL environment variable, or the EDITOR environment variable (in that
344 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
345 and `post-commit` hooks. See linkgit:githooks[5] for more
354 linkgit:git-merge[1],
355 linkgit:git-commit-tree[1]
359 Written by Linus Torvalds <torvalds@osdl.org> and
360 Junio C Hamano <gitster@pobox.com>
365 Part of the linkgit:git[1] suite