]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-commit(1) |
2 | ============= | |
62033318 JH |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-commit - Record changes to the repository |
62033318 JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
353ce815 | 10 | [verse] |
3a5d13a3 | 11 | 'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run] |
c51f6cee | 12 | [(-c | -C) <commit>] [-F <file> | -m <msg>] [--reset-author] |
c9b5fde7 | 13 | [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>] |
dc91e1b2 JA |
14 | [--date=<date>] [--cleanup=<mode>] [--status | --no-status] |
15 | [-i | -o] [--] [<file>...] | |
62033318 JH |
16 | |
17 | DESCRIPTION | |
18 | ----------- | |
d69806d1 JN |
19 | Stores the current contents of the index in a new commit along |
20 | with a log message from the user describing the changes. | |
62033318 | 21 | |
a76c2acb | 22 | The content to be added can be specified in several ways: |
f9935bf9 | 23 | |
0b444cdb | 24 | 1. by using 'git add' to incrementally "add" changes to the |
a76c2acb | 25 | index before using the 'commit' command (Note: even modified |
6c96753d | 26 | files must be "added"); |
5bfc4f23 | 27 | |
0b444cdb | 28 | 2. by using 'git rm' to remove files from the working tree |
a76c2acb | 29 | and the index, again before using the 'commit' command; |
6c96753d | 30 | |
a76c2acb BF |
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 | |
6fc4a7e5 MB |
33 | record the current content of the listed files (which must already |
34 | be known to git); | |
6c96753d | 35 | |
a76c2acb BF |
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 | |
40 | actual commit; | |
6c96753d | 41 | |
6cbf07ef PB |
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 | |
0b444cdb | 44 | operation. Currently, this is done by invoking 'git add --interactive'. |
6cbf07ef | 45 | |
60c2993c | 46 | The `--dry-run` option can be used to obtain a |
6c96753d | 47 | summary of what is included by any of the above for the next |
60c2993c | 48 | commit by giving the same set of parameters (options and paths). |
6c96753d | 49 | |
483bc4f0 | 50 | If you make a commit and then find a mistake immediately after |
0b444cdb | 51 | that, you can recover from it with 'git reset'. |
5bfc4f23 | 52 | |
6d35cc76 | 53 | |
62033318 JH |
54 | OPTIONS |
55 | ------- | |
3240240f SB |
56 | -a:: |
57 | --all:: | |
6c96753d JH |
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. | |
62033318 | 61 | |
3240240f SB |
62 | -C <commit>:: |
63 | --reuse-message=<commit>:: | |
bc47c29e | 64 | Take an existing commit object, and reuse the log message |
62033318 | 65 | and the authorship information (including the timestamp) |
bc47c29e | 66 | when creating the commit. |
62033318 | 67 | |
3240240f SB |
68 | -c <commit>:: |
69 | --reedit-message=<commit>:: | |
bc47c29e SB |
70 | Like '-C', but with '-c' the editor is invoked, so that |
71 | the user can further edit the commit message. | |
72 | ||
c51f6cee EM |
73 | --reset-author:: |
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. | |
77 | ||
7c9f7038 JK |
78 | --short:: |
79 | When doing a dry-run, give the output in the short-format. See | |
80 | linkgit:git-status[1] for details. Implies `--dry-run`. | |
81 | ||
82 | --porcelain:: | |
83 | When doing a dry-run, give the output in a porcelain-ready | |
84 | format. See linkgit:git-status[1] for details. Implies | |
85 | `--dry-run`. | |
86 | ||
87 | -z:: | |
88 | When showing `short` or `porcelain` status output, terminate | |
89 | entries in the status output with NUL, instead of LF. If no | |
90 | format is given, implies the `--porcelain` output format. | |
91 | ||
3240240f SB |
92 | -F <file>:: |
93 | --file=<file>:: | |
62033318 JH |
94 | Take the commit message from the given file. Use '-' to |
95 | read the message from the standard input. | |
96 | ||
c4a7ff52 | 97 | --author=<author>:: |
3334729c JS |
98 | Override the commit author. Specify an explicit author using the |
99 | standard `A U Thor <author@example.com>` format. Otherwise <author> | |
100 | is assumed to be a pattern and is used to search for an existing | |
101 | commit by that author (i.e. rev-list --all -i --author=<author>); | |
102 | the commit author is then copied from the first such commit found. | |
130fcca6 | 103 | |
02b47cd7 MV |
104 | --date=<date>:: |
105 | Override the author date used in the commit. | |
106 | ||
3240240f SB |
107 | -m <msg>:: |
108 | --message=<msg>:: | |
62033318 JH |
109 | Use the given <msg> as the commit message. |
110 | ||
3240240f SB |
111 | -t <file>:: |
112 | --template=<file>:: | |
d1cc130a SG |
113 | Use the contents of the given file as the initial version |
114 | of the commit message. The editor is invoked and you can | |
115 | make subsequent changes. If a message is specified using | |
383e45ce BG |
116 | the `-m` or `-F` options, this option has no effect. This |
117 | overrides the `commit.template` configuration variable. | |
d1cc130a | 118 | |
3240240f SB |
119 | -s:: |
120 | --signoff:: | |
a0178ae2 | 121 | Add Signed-off-by line by the committer at the end of the commit |
09cff066 | 122 | log message. |
3f971fc4 | 123 | |
3240240f SB |
124 | -n:: |
125 | --no-verify:: | |
aa6da6cd | 126 | This option bypasses the pre-commit and commit-msg hooks. |
6998e4db | 127 | See also linkgit:githooks[5]. |
eaa54efc | 128 | |
36863af1 JH |
129 | --allow-empty:: |
130 | Usually recording a commit that has the exact same tree as its | |
17ef10d0 JH |
131 | sole parent commit is a mistake, and the command prevents you |
132 | from making such a commit. This option bypasses the safety, and | |
6b677a28 | 133 | is primarily for use by foreign SCM interface scripts. |
36863af1 | 134 | |
c9b5fde7 ÆAB |
135 | --allow-empty-message:: |
136 | Like --allow-empty this command is primarily for use by foreign | |
6b677a28 | 137 | SCM interface scripts. It allows you to create a commit with an |
c9b5fde7 ÆAB |
138 | empty commit message without using plumbing commands like |
139 | linkgit:git-commit-tree[1]. | |
140 | ||
5f065737 AR |
141 | --cleanup=<mode>:: |
142 | This option sets how the commit message is cleaned up. | |
143 | The '<mode>' can be one of 'verbatim', 'whitespace', 'strip', | |
144 | and 'default'. The 'default' mode will strip leading and | |
145 | trailing empty lines and #commentary from the commit message | |
146 | only if the message is to be edited. Otherwise only whitespace | |
147 | removed. The 'verbatim' mode does not change message at all, | |
148 | 'whitespace' removes just leading/trailing whitespace lines | |
149 | and 'strip' removes both whitespace and commentary. | |
150 | ||
3240240f SB |
151 | -e:: |
152 | --edit:: | |
6d35cc76 JH |
153 | The message taken from file with `-F`, command line with |
154 | `-m`, and from file with `-C` are usually used as the | |
155 | commit log message unmodified. This option lets you | |
156 | further edit the message taken from these sources. | |
157 | ||
ae5d8470 | 158 | --amend:: |
ae5d8470 MR |
159 | Used to amend the tip of the current branch. Prepare the tree |
160 | object you would want to replace the latest commit as usual | |
161 | (this includes the usual -i/-o and explicit paths), and the | |
162 | commit log editor is seeded with the commit message from the | |
163 | tip of the current branch. The commit you create replaces the | |
164 | current tip -- if it was a merge, it will have the parents of | |
165 | the current tip as parents -- so the current top commit is | |
166 | discarded. | |
167 | + | |
6cbd5d7d | 168 | -- |
ae5d8470 | 169 | It is a rough equivalent for: |
6cbd5d7d | 170 | ------ |
ae5d8470 MR |
171 | $ git reset --soft HEAD^ |
172 | $ ... do something else to come up with the right tree ... | |
173 | $ git commit -c ORIG_HEAD | |
6cbd5d7d FD |
174 | |
175 | ------ | |
ae5d8470 | 176 | but can be used to amend a merge commit. |
6cbd5d7d | 177 | -- |
97c33c65 TR |
178 | + |
179 | You should understand the implications of rewriting history if you | |
180 | amend a commit that has already been published. (See the "RECOVERING | |
181 | FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) | |
ae5d8470 | 182 | |
3240240f SB |
183 | -i:: |
184 | --include:: | |
6c96753d JH |
185 | Before making a commit out of staged contents so far, |
186 | stage the contents of paths given on the command line | |
187 | as well. This is usually not what you want unless you | |
188 | are concluding a conflicted merge. | |
62033318 | 189 | |
3240240f SB |
190 | -o:: |
191 | --only:: | |
d4ba07ca JS |
192 | Make a commit only from the paths specified on the |
193 | command line, disregarding any contents that have been | |
194 | staged so far. This is the default mode of operation of | |
0b444cdb | 195 | 'git commit' if any paths are given on the command line, |
d4ba07ca JS |
196 | in which case this option can be omitted. |
197 | If this option is specified together with '--amend', then | |
04c8ce9c | 198 | no paths need to be specified, which can be used to amend |
d4ba07ca JS |
199 | the last commit without committing changes that have |
200 | already been staged. | |
201 | ||
1947bdbc JH |
202 | -u[<mode>]:: |
203 | --untracked-files[=<mode>]:: | |
4bfee30a MSO |
204 | Show untracked files (Default: 'all'). |
205 | + | |
206 | The mode parameter is optional, and is used to specify | |
e9e92198 JH |
207 | the handling of untracked files. |
208 | + | |
209 | The possible options are: | |
4bfee30a | 210 | + |
6c2ce048 | 211 | - 'no' - Show no untracked files |
4bfee30a MSO |
212 | - 'normal' - Shows untracked files and directories |
213 | - 'all' - Also shows individual files in untracked directories. | |
d6293d1f MSO |
214 | + |
215 | See linkgit:git-config[1] for configuration variable | |
216 | used to change the default for when the option is not | |
217 | specified. | |
af83bed6 | 218 | |
3240240f SB |
219 | -v:: |
220 | --verbose:: | |
af83bed6 JN |
221 | Show unified diff between the HEAD commit and what |
222 | would be committed at the bottom of the commit message | |
223 | template. Note that this diff output doesn't have its | |
224 | lines prefixed with '#'. | |
225 | ||
3240240f SB |
226 | -q:: |
227 | --quiet:: | |
23bfbb81 | 228 | Suppress commit summary message. |
ebd124c6 | 229 | |
3a5d13a3 JH |
230 | --dry-run:: |
231 | Do not create a commit, but show a list of paths that are | |
232 | to be committed, paths with local changes that will be left | |
233 | uncommitted and paths that are untracked. | |
234 | ||
bed575e4 JHI |
235 | --status:: |
236 | Include the output of linkgit:git-status[1] in the commit | |
237 | message template when using an editor to prepare the commit | |
238 | message. Defaults to on, but can be used to override | |
239 | configuration variable commit.status. | |
240 | ||
241 | --no-status:: | |
242 | Do not include the output of linkgit:git-status[1] in the | |
243 | commit message template when using an editor to prepare the | |
244 | default commit message. | |
245 | ||
e994004f | 246 | \--:: |
4170a195 JH |
247 | Do not interpret any more arguments as options. |
248 | ||
249 | <file>...:: | |
6c96753d JH |
250 | When files are given on the command line, the command |
251 | commits the contents of the named files, without | |
252 | recording the changes already staged. The contents of | |
253 | these files are also staged for the next commit on top | |
254 | of what have been staged before. | |
3ae854c3 | 255 | |
788070a2 MV |
256 | :git-commit: 1 |
257 | include::date-formats.txt[] | |
3ae854c3 | 258 | |
6c96753d JH |
259 | EXAMPLES |
260 | -------- | |
261 | When recording your own work, the contents of modified files in | |
262 | your working tree are temporarily stored to a staging area | |
0b444cdb | 263 | called the "index" with 'git add'. A file can be |
97e9a221 | 264 | reverted back, only in the index but not in the working tree, |
b1889c36 | 265 | to that of the last commit with `git reset HEAD -- <file>`, |
0b444cdb | 266 | which effectively reverts 'git add' and prevents the changes to |
97e9a221 JX |
267 | this file from participating in the next commit. After building |
268 | the state to be committed incrementally with these commands, | |
269 | `git commit` (without any pathname parameter) is used to record what | |
6c96753d JH |
270 | has been staged so far. This is the most basic form of the |
271 | command. An example: | |
272 | ||
273 | ------------ | |
274 | $ edit hello.c | |
275 | $ git rm goodbye.c | |
276 | $ git add hello.c | |
277 | $ git commit | |
278 | ------------ | |
279 | ||
6c96753d JH |
280 | Instead of staging files after each individual change, you can |
281 | tell `git commit` to notice the changes to the files whose | |
282 | contents are tracked in | |
283 | your working tree and do corresponding `git add` and `git rm` | |
284 | for you. That is, this example does the same as the earlier | |
285 | example if there is no other change in your working tree: | |
286 | ||
287 | ------------ | |
288 | $ edit hello.c | |
289 | $ rm goodbye.c | |
290 | $ git commit -a | |
291 | ------------ | |
292 | ||
293 | The command `git commit -a` first looks at your working tree, | |
294 | notices that you have modified hello.c and removed goodbye.c, | |
295 | and performs necessary `git add` and `git rm` for you. | |
296 | ||
297 | After staging changes to many files, you can alter the order the | |
298 | changes are recorded in, by giving pathnames to `git commit`. | |
299 | When pathnames are given, the command makes a commit that | |
300 | only records the changes made to the named paths: | |
301 | ||
302 | ------------ | |
303 | $ edit hello.c hello.h | |
304 | $ git add hello.c hello.h | |
305 | $ edit Makefile | |
306 | $ git commit Makefile | |
307 | ------------ | |
308 | ||
309 | This makes a commit that records the modification to `Makefile`. | |
310 | The changes staged for `hello.c` and `hello.h` are not included | |
311 | in the resulting commit. However, their changes are not lost -- | |
312 | they are still staged and merely held back. After the above | |
313 | sequence, if you do: | |
314 | ||
315 | ------------ | |
316 | $ git commit | |
317 | ------------ | |
318 | ||
319 | this second commit would record the changes to `hello.c` and | |
320 | `hello.h` as expected. | |
321 | ||
0b444cdb | 322 | After a merge (initiated by 'git merge' or 'git pull') stops |
483bc4f0 | 323 | because of conflicts, cleanly merged |
6c96753d JH |
324 | paths are already staged to be committed for you, and paths that |
325 | conflicted are left in unmerged state. You would have to first | |
0b444cdb | 326 | check which paths are conflicting with 'git status' |
6c96753d | 327 | and after fixing them manually in your working tree, you would |
0b444cdb | 328 | stage the result as usual with 'git add': |
6c96753d JH |
329 | |
330 | ------------ | |
331 | $ git status | grep unmerged | |
332 | unmerged: hello.c | |
333 | $ edit hello.c | |
334 | $ git add hello.c | |
335 | ------------ | |
336 | ||
337 | After resolving conflicts and staging the result, `git ls-files -u` | |
338 | would stop mentioning the conflicted path. When you are done, | |
339 | run `git commit` to finally record the merge: | |
340 | ||
341 | ------------ | |
342 | $ git commit | |
343 | ------------ | |
344 | ||
345 | As with the case to record your own changes, you can use `-a` | |
346 | option to save typing. One difference is that during a merge | |
347 | resolution, you cannot use `git commit` with pathnames to | |
348 | alter the order the changes are committed, because the merge | |
349 | should be recorded as a single commit. In fact, the command | |
350 | refuses to run when given pathnames (but see `-i` option). | |
351 | ||
352 | ||
5dc7bcc2 JH |
353 | DISCUSSION |
354 | ---------- | |
355 | ||
936f32d3 JH |
356 | Though not required, it's a good idea to begin the commit message |
357 | with a single short (less than 50 character) line summarizing the | |
358 | change, followed by a blank line and then a more thorough description. | |
359 | Tools that turn commits into email, for example, use the first line | |
360 | on the Subject: line and the rest of the commit in the body. | |
361 | ||
5dc7bcc2 JH |
362 | include::i18n.txt[] |
363 | ||
ef0c2abf AR |
364 | ENVIRONMENT AND CONFIGURATION VARIABLES |
365 | --------------------------------------- | |
366 | The editor used to edit the commit log message will be chosen from the | |
367 | GIT_EDITOR environment variable, the core.editor configuration variable, the | |
368 | VISUAL environment variable, or the EDITOR environment variable (in that | |
b4479f07 | 369 | order). See linkgit:git-var[1] for details. |
6c96753d JH |
370 | |
371 | HOOKS | |
372 | ----- | |
8089c85b | 373 | This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`, |
6998e4db | 374 | and `post-commit` hooks. See linkgit:githooks[5] for more |
6c96753d | 375 | information. |
130fcca6 | 376 | |
130fcca6 | 377 | |
6c96753d JH |
378 | SEE ALSO |
379 | -------- | |
5162e697 DM |
380 | linkgit:git-add[1], |
381 | linkgit:git-rm[1], | |
382 | linkgit:git-mv[1], | |
383 | linkgit:git-merge[1], | |
384 | linkgit:git-commit-tree[1] | |
130fcca6 | 385 | |
62033318 JH |
386 | Author |
387 | ------ | |
3f971fc4 | 388 | Written by Linus Torvalds <torvalds@osdl.org> and |
59eb68aa | 389 | Junio C Hamano <gitster@pobox.com> |
3f971fc4 | 390 | |
62033318 JH |
391 | |
392 | GIT | |
393 | --- | |
9e1f0a85 | 394 | Part of the linkgit:git[1] suite |