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>] [--reset-author]
13 [--allow-empty] [--no-verify] [-e] [--author=<author>]
14 [--cleanup=<mode>] [--status | --no-status] [--]
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 When used with -C/-c/--amend options, declare that the
75 authorship of the resulting commit now belongs of the committer.
76 This also renews the author timestamp.
80 Take the commit message from the given file. Use '-' to
81 read the message from the standard input.
84 Override the author name used in the commit. You can use the
85 standard `A U Thor <author@example.com>` format. Otherwise,
86 an existing commit that matches the given string and its author
91 Use the given <msg> as the commit message.
95 Use the contents of the given file as the initial version
96 of the commit message. The editor is invoked and you can
97 make subsequent changes. If a message is specified using
98 the `-m` or `-F` options, this option has no effect. This
99 overrides the `commit.template` configuration variable.
103 Add Signed-off-by line by the committer at the end of the commit
108 This option bypasses the pre-commit and commit-msg hooks.
109 See also linkgit:githooks[5].
112 Usually recording a commit that has the exact same tree as its
113 sole parent commit is a mistake, and the command prevents you
114 from making such a commit. This option bypasses the safety, and
115 is primarily for use by foreign scm interface scripts.
118 This option sets how the commit message is cleaned up.
119 The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
120 and 'default'. The 'default' mode will strip leading and
121 trailing empty lines and #commentary from the commit message
122 only if the message is to be edited. Otherwise only whitespace
123 removed. The 'verbatim' mode does not change message at all,
124 'whitespace' removes just leading/trailing whitespace lines
125 and 'strip' removes both whitespace and commentary.
129 The message taken from file with `-F`, command line with
130 `-m`, and from file with `-C` are usually used as the
131 commit log message unmodified. This option lets you
132 further edit the message taken from these sources.
135 Used to amend the tip of the current branch. Prepare the tree
136 object you would want to replace the latest commit as usual
137 (this includes the usual -i/-o and explicit paths), and the
138 commit log editor is seeded with the commit message from the
139 tip of the current branch. The commit you create replaces the
140 current tip -- if it was a merge, it will have the parents of
141 the current tip as parents -- so the current top commit is
145 It is a rough equivalent for:
147 $ git reset --soft HEAD^
148 $ ... do something else to come up with the right tree ...
149 $ git commit -c ORIG_HEAD
152 but can be used to amend a merge commit.
155 You should understand the implications of rewriting history if you
156 amend a commit that has already been published. (See the "RECOVERING
157 FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
161 Before making a commit out of staged contents so far,
162 stage the contents of paths given on the command line
163 as well. This is usually not what you want unless you
164 are concluding a conflicted merge.
168 Make a commit only from the paths specified on the
169 command line, disregarding any contents that have been
170 staged so far. This is the default mode of operation of
171 'git-commit' if any paths are given on the command line,
172 in which case this option can be omitted.
173 If this option is specified together with '--amend', then
174 no paths need to be specified, which can be used to amend
175 the last commit without committing changes that have
179 --untracked-files[=<mode>]::
180 Show untracked files (Default: 'all').
182 The mode parameter is optional, and is used to specify
183 the handling of untracked files. The possible options are:
186 - 'no' - Show no untracked files
187 - 'normal' - Shows untracked files and directories
188 - 'all' - Also shows individual files in untracked directories.
191 See linkgit:git-config[1] for configuration variable
192 used to change the default for when the option is not
197 Show unified diff between the HEAD commit and what
198 would be committed at the bottom of the commit message
199 template. Note that this diff output doesn't have its
200 lines prefixed with '#'.
204 Suppress commit summary message.
207 Do not create a commit, but show a list of paths that are
208 to be committed, paths with local changes that will be left
209 uncommitted and paths that are untracked.
212 Include the output of linkgit:git-status[1] in the commit
213 message template when using an editor to prepare the commit
214 message. Defaults to on, but can be used to override
215 configuration variable commit.status.
218 Do not include the output of linkgit:git-status[1] in the
219 commit message template when using an editor to prepare the
220 default commit message.
223 Do not interpret any more arguments as options.
226 When files are given on the command line, the command
227 commits the contents of the named files, without
228 recording the changes already staged. The contents of
229 these files are also staged for the next commit on top
230 of what have been staged before.
235 When recording your own work, the contents of modified files in
236 your working tree are temporarily stored to a staging area
237 called the "index" with 'git-add'. A file can be
238 reverted back, only in the index but not in the working tree,
239 to that of the last commit with `git reset HEAD -- <file>`,
240 which effectively reverts 'git-add' and prevents the changes to
241 this file from participating in the next commit. After building
242 the state to be committed incrementally with these commands,
243 `git commit` (without any pathname parameter) is used to record what
244 has been staged so far. This is the most basic form of the
254 Instead of staging files after each individual change, you can
255 tell `git commit` to notice the changes to the files whose
256 contents are tracked in
257 your working tree and do corresponding `git add` and `git rm`
258 for you. That is, this example does the same as the earlier
259 example if there is no other change in your working tree:
267 The command `git commit -a` first looks at your working tree,
268 notices that you have modified hello.c and removed goodbye.c,
269 and performs necessary `git add` and `git rm` for you.
271 After staging changes to many files, you can alter the order the
272 changes are recorded in, by giving pathnames to `git commit`.
273 When pathnames are given, the command makes a commit that
274 only records the changes made to the named paths:
277 $ edit hello.c hello.h
278 $ git add hello.c hello.h
280 $ git commit Makefile
283 This makes a commit that records the modification to `Makefile`.
284 The changes staged for `hello.c` and `hello.h` are not included
285 in the resulting commit. However, their changes are not lost --
286 they are still staged and merely held back. After the above
293 this second commit would record the changes to `hello.c` and
294 `hello.h` as expected.
296 After a merge (initiated by 'git-merge' or 'git-pull') stops
297 because of conflicts, cleanly merged
298 paths are already staged to be committed for you, and paths that
299 conflicted are left in unmerged state. You would have to first
300 check which paths are conflicting with 'git-status'
301 and after fixing them manually in your working tree, you would
302 stage the result as usual with 'git-add':
305 $ git status | grep unmerged
311 After resolving conflicts and staging the result, `git ls-files -u`
312 would stop mentioning the conflicted path. When you are done,
313 run `git commit` to finally record the merge:
319 As with the case to record your own changes, you can use `-a`
320 option to save typing. One difference is that during a merge
321 resolution, you cannot use `git commit` with pathnames to
322 alter the order the changes are committed, because the merge
323 should be recorded as a single commit. In fact, the command
324 refuses to run when given pathnames (but see `-i` option).
330 Though not required, it's a good idea to begin the commit message
331 with a single short (less than 50 character) line summarizing the
332 change, followed by a blank line and then a more thorough description.
333 Tools that turn commits into email, for example, use the first line
334 on the Subject: line and the rest of the commit in the body.
338 ENVIRONMENT AND CONFIGURATION VARIABLES
339 ---------------------------------------
340 The editor used to edit the commit log message will be chosen from the
341 GIT_EDITOR environment variable, the core.editor configuration variable, the
342 VISUAL environment variable, or the EDITOR environment variable (in that
343 order). See linkgit:git-var[1] for details.
347 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
348 and `post-commit` hooks. See linkgit:githooks[5] for more
357 linkgit:git-merge[1],
358 linkgit:git-commit-tree[1]
362 Written by Linus Torvalds <torvalds@osdl.org> and
363 Junio C Hamano <gitster@pobox.com>
368 Part of the linkgit:git[1] suite