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