6 git-commit - Record changes to the repository
11 'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend]
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;
34 4. by using the -a switch with the 'commit' command to automatically
35 "add" changes from all known files (i.e. all files that are already
36 listed in the index) and to automatically "rm" files in the index
37 that have been removed from the working tree, and then perform the
40 5. by using the --interactive switch with the 'commit' command to decide one
41 by one which files should be part of the commit, before finalizing the
42 operation. Currently, this is done by invoking 'git-add --interactive'.
44 The 'git-status' command can be used to obtain a
45 summary of what is included by any of the above for the next
46 commit by giving the same set of parameters you would give to
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.
74 Take the commit message from the given file. Use '-' to
75 read the message from the standard input.
78 Override the author name used in the commit. You can use the
79 standard `A U Thor <author@example.com>` format. Otherwise,
80 an existing commit that matches the given string and its author
85 Use the given <msg> as the commit message.
89 Use the contents of the given file as the initial version
90 of the commit message. The editor is invoked and you can
91 make subsequent changes. If a message is specified using
92 the `-m` or `-F` options, this option has no effect. This
93 overrides the `commit.template` configuration variable.
97 Add Signed-off-by line at the end of the commit message.
101 This option bypasses the pre-commit and commit-msg hooks.
102 See also linkgit:githooks[5].
105 Usually recording a commit that has the exact same tree as its
106 sole parent commit is a mistake, and the command prevents you
107 from making such a commit. This option bypasses the safety, and
108 is primarily for use by foreign scm interface scripts.
111 This option sets how the commit message is cleaned up.
112 The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
113 and 'default'. The 'default' mode will strip leading and
114 trailing empty lines and #commentary from the commit message
115 only if the message is to be edited. Otherwise only whitespace
116 removed. The 'verbatim' mode does not change message at all,
117 'whitespace' removes just leading/trailing whitespace lines
118 and 'strip' removes both whitespace and commentary.
122 The message taken from file with `-F`, command line with
123 `-m`, and from file with `-C` are usually used as the
124 commit log message unmodified. This option lets you
125 further edit the message taken from these sources.
128 Used to amend the tip of the current branch. Prepare the tree
129 object you would want to replace the latest commit as usual
130 (this includes the usual -i/-o and explicit paths), and the
131 commit log editor is seeded with the commit message from the
132 tip of the current branch. The commit you create replaces the
133 current tip -- if it was a merge, it will have the parents of
134 the current tip as parents -- so the current top commit is
138 It is a rough equivalent for:
140 $ git reset --soft HEAD^
141 $ ... do something else to come up with the right tree ...
142 $ git commit -c ORIG_HEAD
145 but can be used to amend a merge commit.
150 Before making a commit out of staged contents so far,
151 stage the contents of paths given on the command line
152 as well. This is usually not what you want unless you
153 are concluding a conflicted merge.
157 Make a commit only from the paths specified on the
158 command line, disregarding any contents that have been
159 staged so far. This is the default mode of operation of
160 'git-commit' if any paths are given on the command line,
161 in which case this option can be omitted.
162 If this option is specified together with '--amend', then
163 no paths need be specified, which can be used to amend
164 the last commit without committing changes that have
168 --untracked-files[=<mode>]::
169 Show untracked files (Default: 'all').
171 The mode parameter is optional, and is used to specify
172 the handling of untracked files. The possible options are:
175 - 'no' - Show no untracked files
176 - 'normal' - Shows untracked files and directories
177 - 'all' - Also shows individual files in untracked directories.
180 See linkgit:git-config[1] for configuration variable
181 used to change the default for when the option is not
186 Show unified diff between the HEAD commit and what
187 would be committed at the bottom of the commit message
188 template. Note that this diff output doesn't have its
189 lines prefixed with '#'.
193 Suppress commit summary message.
196 Do not interpret any more arguments as options.
199 When files are given on the command line, the command
200 commits the contents of the named files, without
201 recording the changes already staged. The contents of
202 these files are also staged for the next commit on top
203 of what have been staged before.
208 When recording your own work, the contents of modified files in
209 your working tree are temporarily stored to a staging area
210 called the "index" with 'git-add'. A file can be
211 reverted back, only in the index but not in the working tree,
212 to that of the last commit with `git reset HEAD -- <file>`,
213 which effectively reverts 'git-add' and prevents the changes to
214 this file from participating in the next commit. After building
215 the state to be committed incrementally with these commands,
216 `git commit` (without any pathname parameter) is used to record what
217 has been staged so far. This is the most basic form of the
227 Instead of staging files after each individual change, you can
228 tell `git commit` to notice the changes to the files whose
229 contents are tracked in
230 your working tree and do corresponding `git add` and `git rm`
231 for you. That is, this example does the same as the earlier
232 example if there is no other change in your working tree:
240 The command `git commit -a` first looks at your working tree,
241 notices that you have modified hello.c and removed goodbye.c,
242 and performs necessary `git add` and `git rm` for you.
244 After staging changes to many files, you can alter the order the
245 changes are recorded in, by giving pathnames to `git commit`.
246 When pathnames are given, the command makes a commit that
247 only records the changes made to the named paths:
250 $ edit hello.c hello.h
251 $ git add hello.c hello.h
253 $ git commit Makefile
256 This makes a commit that records the modification to `Makefile`.
257 The changes staged for `hello.c` and `hello.h` are not included
258 in the resulting commit. However, their changes are not lost --
259 they are still staged and merely held back. After the above
266 this second commit would record the changes to `hello.c` and
267 `hello.h` as expected.
269 After a merge (initiated by 'git-merge' or 'git-pull') stops
270 because of conflicts, cleanly merged
271 paths are already staged to be committed for you, and paths that
272 conflicted are left in unmerged state. You would have to first
273 check which paths are conflicting with 'git-status'
274 and after fixing them manually in your working tree, you would
275 stage the result as usual with 'git-add':
278 $ git status | grep unmerged
284 After resolving conflicts and staging the result, `git ls-files -u`
285 would stop mentioning the conflicted path. When you are done,
286 run `git commit` to finally record the merge:
292 As with the case to record your own changes, you can use `-a`
293 option to save typing. One difference is that during a merge
294 resolution, you cannot use `git commit` with pathnames to
295 alter the order the changes are committed, because the merge
296 should be recorded as a single commit. In fact, the command
297 refuses to run when given pathnames (but see `-i` option).
303 Though not required, it's a good idea to begin the commit message
304 with a single short (less than 50 character) line summarizing the
305 change, followed by a blank line and then a more thorough description.
306 Tools that turn commits into email, for example, use the first line
307 on the Subject: line and the rest of the commit in the body.
311 ENVIRONMENT AND CONFIGURATION VARIABLES
312 ---------------------------------------
313 The editor used to edit the commit log message will be chosen from the
314 GIT_EDITOR environment variable, the core.editor configuration variable, the
315 VISUAL environment variable, or the EDITOR environment variable (in that
320 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
321 and `post-commit` hooks. See linkgit:githooks[5] for more
330 linkgit:git-merge[1],
331 linkgit:git-commit-tree[1]
335 Written by Linus Torvalds <torvalds@osdl.org> and
336 Junio C Hamano <gitster@pobox.com>
341 Part of the linkgit:git[1] suite
projects / git / blob