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>] [--] [[-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 used with -C/-c/--amend options, declare that the
74 authorship of the resulting commit now belongs of the committer.
75 This also renews the author timestamp.
79 Take the commit message from the given file. Use '-' to
80 read the message from the standard input.
83 Override the author name used in the commit. You can use the
84 standard `A U Thor <author@example.com>` format. Otherwise,
85 an existing commit that matches the given string and its author
90 Use the given <msg> as the commit message.
94 Use the contents of the given file as the initial version
95 of the commit message. The editor is invoked and you can
96 make subsequent changes. If a message is specified using
97 the `-m` or `-F` options, this option has no effect. This
98 overrides the `commit.template` configuration variable.
102 Add Signed-off-by line by the committer at the end of the commit
107 This option bypasses the pre-commit and commit-msg hooks.
108 See also linkgit:githooks[5].
111 Usually recording a commit that has the exact same tree as its
112 sole parent commit is a mistake, and the command prevents you
113 from making such a commit. This option bypasses the safety, and
114 is primarily for use by foreign scm interface scripts.
117 This option sets how the commit message is cleaned up.
118 The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
119 and 'default'. The 'default' mode will strip leading and
120 trailing empty lines and #commentary from the commit message
121 only if the message is to be edited. Otherwise only whitespace
122 removed. The 'verbatim' mode does not change message at all,
123 'whitespace' removes just leading/trailing whitespace lines
124 and 'strip' removes both whitespace and commentary.
128 The message taken from file with `-F`, command line with
129 `-m`, and from file with `-C` are usually used as the
130 commit log message unmodified. This option lets you
131 further edit the message taken from these sources.
134 Used to amend the tip of the current branch. Prepare the tree
135 object you would want to replace the latest commit as usual
136 (this includes the usual -i/-o and explicit paths), and the
137 commit log editor is seeded with the commit message from the
138 tip of the current branch. The commit you create replaces the
139 current tip -- if it was a merge, it will have the parents of
140 the current tip as parents -- so the current top commit is
144 It is a rough equivalent for:
146 $ git reset --soft HEAD^
147 $ ... do something else to come up with the right tree ...
148 $ git commit -c ORIG_HEAD
151 but can be used to amend a merge commit.
154 You should understand the implications of rewriting history if you
155 amend a commit that has already been published. (See the "RECOVERING
156 FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
160 Before making a commit out of staged contents so far,
161 stage the contents of paths given on the command line
162 as well. This is usually not what you want unless you
163 are concluding a conflicted merge.
167 Make a commit only from the paths specified on the
168 command line, disregarding any contents that have been
169 staged so far. This is the default mode of operation of
170 'git-commit' if any paths are given on the command line,
171 in which case this option can be omitted.
172 If this option is specified together with '--amend', then
173 no paths need to be specified, which can be used to amend
174 the last commit without committing changes that have
178 --untracked-files[=<mode>]::
179 Show untracked files (Default: 'all').
181 The mode parameter is optional, and is used to specify
182 the handling of untracked files. The possible options are:
185 - 'no' - Show no untracked files
186 - 'normal' - Shows untracked files and directories
187 - 'all' - Also shows individual files in untracked directories.
190 See linkgit:git-config[1] for configuration variable
191 used to change the default for when the option is not
196 Show unified diff between the HEAD commit and what
197 would be committed at the bottom of the commit message
198 template. Note that this diff output doesn't have its
199 lines prefixed with '#'.
203 Suppress commit summary message.
206 Do not create a commit, but show a list of paths that are
207 to be committed, paths with local changes that will be left
208 uncommitted and paths that are untracked.
211 Do not interpret any more arguments as options.
214 When files are given on the command line, the command
215 commits the contents of the named files, without
216 recording the changes already staged. The contents of
217 these files are also staged for the next commit on top
218 of what have been staged before.
223 When recording your own work, the contents of modified files in
224 your working tree are temporarily stored to a staging area
225 called the "index" with 'git-add'. A file can be
226 reverted back, only in the index but not in the working tree,
227 to that of the last commit with `git reset HEAD -- <file>`,
228 which effectively reverts 'git-add' and prevents the changes to
229 this file from participating in the next commit. After building
230 the state to be committed incrementally with these commands,
231 `git commit` (without any pathname parameter) is used to record what
232 has been staged so far. This is the most basic form of the
242 Instead of staging files after each individual change, you can
243 tell `git commit` to notice the changes to the files whose
244 contents are tracked in
245 your working tree and do corresponding `git add` and `git rm`
246 for you. That is, this example does the same as the earlier
247 example if there is no other change in your working tree:
255 The command `git commit -a` first looks at your working tree,
256 notices that you have modified hello.c and removed goodbye.c,
257 and performs necessary `git add` and `git rm` for you.
259 After staging changes to many files, you can alter the order the
260 changes are recorded in, by giving pathnames to `git commit`.
261 When pathnames are given, the command makes a commit that
262 only records the changes made to the named paths:
265 $ edit hello.c hello.h
266 $ git add hello.c hello.h
268 $ git commit Makefile
271 This makes a commit that records the modification to `Makefile`.
272 The changes staged for `hello.c` and `hello.h` are not included
273 in the resulting commit. However, their changes are not lost --
274 they are still staged and merely held back. After the above
281 this second commit would record the changes to `hello.c` and
282 `hello.h` as expected.
284 After a merge (initiated by 'git-merge' or 'git-pull') stops
285 because of conflicts, cleanly merged
286 paths are already staged to be committed for you, and paths that
287 conflicted are left in unmerged state. You would have to first
288 check which paths are conflicting with 'git-status'
289 and after fixing them manually in your working tree, you would
290 stage the result as usual with 'git-add':
293 $ git status | grep unmerged
299 After resolving conflicts and staging the result, `git ls-files -u`
300 would stop mentioning the conflicted path. When you are done,
301 run `git commit` to finally record the merge:
307 As with the case to record your own changes, you can use `-a`
308 option to save typing. One difference is that during a merge
309 resolution, you cannot use `git commit` with pathnames to
310 alter the order the changes are committed, because the merge
311 should be recorded as a single commit. In fact, the command
312 refuses to run when given pathnames (but see `-i` option).
318 Though not required, it's a good idea to begin the commit message
319 with a single short (less than 50 character) line summarizing the
320 change, followed by a blank line and then a more thorough description.
321 Tools that turn commits into email, for example, use the first line
322 on the Subject: line and the rest of the commit in the body.
326 ENVIRONMENT AND CONFIGURATION VARIABLES
327 ---------------------------------------
328 The editor used to edit the commit log message will be chosen from the
329 GIT_EDITOR environment variable, the core.editor configuration variable, the
330 VISUAL environment variable, or the EDITOR environment variable (in that
331 order). See linkgit:git-var[1] for details.
335 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
336 and `post-commit` hooks. See linkgit:githooks[5] for more
345 linkgit:git-merge[1],
346 linkgit:git-commit-tree[1]
350 Written by Linus Torvalds <torvalds@osdl.org> and
351 Junio C Hamano <gitster@pobox.com>
356 Part of the linkgit:git[1] suite
projects / git / blob