]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/git-commit.txt
clone: allow "--bare" with "-o"
[thirdparty/git.git] / Documentation / git-commit.txt
1 git-commit(1)
2 =============
3
4 NAME
5 ----
6 git-commit - Record changes to the repository
7
8 SYNOPSIS
9 --------
10 [verse]
11 'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
12 [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
13 [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
14 [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
15 [--date=<date>] [--cleanup=<mode>] [--[no-]status]
16 [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
17 [(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]
18 [--] [<pathspec>...]
19
20 DESCRIPTION
21 -----------
22 Create a new commit containing the current contents of the index and
23 the given log message describing the changes. The new commit is a
24 direct child of HEAD, usually the tip of the current branch, and the
25 branch is updated to point to it (unless no branch is associated with
26 the working tree, in which case HEAD is "detached" as described in
27 linkgit:git-checkout[1]).
28
29 The content to be committed can be specified in several ways:
30
31 1. by using linkgit:git-add[1] to incrementally "add" changes to the
32 index before using the 'commit' command (Note: even modified files
33 must be "added");
34
35 2. by using linkgit:git-rm[1] to remove files from the working tree
36 and the index, again before using the 'commit' command;
37
38 3. by listing files as arguments to the 'commit' command
39 (without --interactive or --patch switch), in which
40 case the commit will ignore changes staged in the index, and instead
41 record the current content of the listed files (which must already
42 be known to Git);
43
44 4. by using the -a switch with the 'commit' command to automatically
45 "add" changes from all known files (i.e. all files that are already
46 listed in the index) and to automatically "rm" files in the index
47 that have been removed from the working tree, and then perform the
48 actual commit;
49
50 5. by using the --interactive or --patch switches with the 'commit' command
51 to decide one by one which files or hunks should be part of the commit
52 in addition to contents in the index,
53 before finalizing the operation. See the ``Interactive Mode'' section of
54 linkgit:git-add[1] to learn how to operate these modes.
55
56 The `--dry-run` option can be used to obtain a
57 summary of what is included by any of the above for the next
58 commit by giving the same set of parameters (options and paths).
59
60 If you make a commit and then find a mistake immediately after
61 that, you can recover from it with 'git reset'.
62
63 :git-commit: 1
64
65 OPTIONS
66 -------
67 -a::
68 --all::
69 Tell the command to automatically stage files that have
70 been modified and deleted, but new files you have not
71 told Git about are not affected.
72
73 -p::
74 --patch::
75 Use the interactive patch selection interface to choose
76 which changes to commit. See linkgit:git-add[1] for
77 details.
78
79 -C <commit>::
80 --reuse-message=<commit>::
81 Take an existing commit object, and reuse the log message
82 and the authorship information (including the timestamp)
83 when creating the commit.
84
85 -c <commit>::
86 --reedit-message=<commit>::
87 Like '-C', but with `-c` the editor is invoked, so that
88 the user can further edit the commit message.
89
90 --fixup=[(amend|reword):]<commit>::
91 Create a new commit which "fixes up" `<commit>` when applied with
92 `git rebase --autosquash`. Plain `--fixup=<commit>` creates a
93 "fixup!" commit which changes the content of `<commit>` but leaves
94 its log message untouched. `--fixup=amend:<commit>` is similar but
95 creates an "amend!" commit which also replaces the log message of
96 `<commit>` with the log message of the "amend!" commit.
97 `--fixup=reword:<commit>` creates an "amend!" commit which
98 replaces the log message of `<commit>` with its own log message
99 but makes no changes to the content of `<commit>`.
100 +
101 The commit created by plain `--fixup=<commit>` has a subject
102 composed of "fixup!" followed by the subject line from <commit>,
103 and is recognized specially by `git rebase --autosquash`. The `-m`
104 option may be used to supplement the log message of the created
105 commit, but the additional commentary will be thrown away once the
106 "fixup!" commit is squashed into `<commit>` by
107 `git rebase --autosquash`.
108 +
109 The commit created by `--fixup=amend:<commit>` is similar but its
110 subject is instead prefixed with "amend!". The log message of
111 <commit> is copied into the log message of the "amend!" commit and
112 opened in an editor so it can be refined. When `git rebase
113 --autosquash` squashes the "amend!" commit into `<commit>`, the
114 log message of `<commit>` is replaced by the refined log message
115 from the "amend!" commit. It is an error for the "amend!" commit's
116 log message to be empty unless `--allow-empty-message` is
117 specified.
118 +
119 `--fixup=reword:<commit>` is shorthand for `--fixup=amend:<commit>
120 --only`. It creates an "amend!" commit with only a log message
121 (ignoring any changes staged in the index). When squashed by `git
122 rebase --autosquash`, it replaces the log message of `<commit>`
123 without making any other changes.
124 +
125 Neither "fixup!" nor "amend!" commits change authorship of
126 `<commit>` when applied by `git rebase --autosquash`.
127 See linkgit:git-rebase[1] for details.
128
129 --squash=<commit>::
130 Construct a commit message for use with `rebase --autosquash`.
131 The commit message subject line is taken from the specified
132 commit with a prefix of "squash! ". Can be used with additional
133 commit message options (`-m`/`-c`/`-C`/`-F`). See
134 linkgit:git-rebase[1] for details.
135
136 --reset-author::
137 When used with -C/-c/--amend options, or when committing after a
138 conflicting cherry-pick, declare that the authorship of the
139 resulting commit now belongs to the committer. This also renews
140 the author timestamp.
141
142 --short::
143 When doing a dry-run, give the output in the short-format. See
144 linkgit:git-status[1] for details. Implies `--dry-run`.
145
146 --branch::
147 Show the branch and tracking info even in short-format.
148
149 --porcelain::
150 When doing a dry-run, give the output in a porcelain-ready
151 format. See linkgit:git-status[1] for details. Implies
152 `--dry-run`.
153
154 --long::
155 When doing a dry-run, give the output in the long-format.
156 Implies `--dry-run`.
157
158 -z::
159 --null::
160 When showing `short` or `porcelain` status output, print the
161 filename verbatim and terminate the entries with NUL, instead of LF.
162 If no format is given, implies the `--porcelain` output format.
163 Without the `-z` option, filenames with "unusual" characters are
164 quoted as explained for the configuration variable `core.quotePath`
165 (see linkgit:git-config[1]).
166
167 -F <file>::
168 --file=<file>::
169 Take the commit message from the given file. Use '-' to
170 read the message from the standard input.
171
172 --author=<author>::
173 Override the commit author. Specify an explicit author using the
174 standard `A U Thor <author@example.com>` format. Otherwise <author>
175 is assumed to be a pattern and is used to search for an existing
176 commit by that author (i.e. rev-list --all -i --author=<author>);
177 the commit author is then copied from the first such commit found.
178
179 --date=<date>::
180 Override the author date used in the commit.
181
182 -m <msg>::
183 --message=<msg>::
184 Use the given <msg> as the commit message.
185 If multiple `-m` options are given, their values are
186 concatenated as separate paragraphs.
187 +
188 The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
189
190 -t <file>::
191 --template=<file>::
192 When editing the commit message, start the editor with the
193 contents in the given file. The `commit.template` configuration
194 variable is often used to give this option implicitly to the
195 command. This mechanism can be used by projects that want to
196 guide participants with some hints on what to write in the message
197 in what order. If the user exits the editor without editing the
198 message, the commit is aborted. This has no effect when a message
199 is given by other means, e.g. with the `-m` or `-F` options.
200
201 include::signoff-option.txt[]
202
203 --trailer <token>[(=|:)<value>]::
204 Specify a (<token>, <value>) pair that should be applied as a
205 trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \
206 <committer@example.com>" --trailer "Helped-by:C O Mitter \
207 <committer@example.com>"` will add the "Signed-off-by" trailer
208 and the "Helped-by" trailer to the commit message.)
209 The `trailer.*` configuration variables
210 (linkgit:git-interpret-trailers[1]) can be used to define if
211 a duplicated trailer is omitted, where in the run of trailers
212 each trailer would appear, and other details.
213
214 -n::
215 --[no-]verify::
216 By default, the pre-commit and commit-msg hooks are run.
217 When any of `--no-verify` or `-n` is given, these are bypassed.
218 See also linkgit:githooks[5].
219
220 --allow-empty::
221 Usually recording a commit that has the exact same tree as its
222 sole parent commit is a mistake, and the command prevents you
223 from making such a commit. This option bypasses the safety, and
224 is primarily for use by foreign SCM interface scripts.
225
226 --allow-empty-message::
227 Like --allow-empty this command is primarily for use by foreign
228 SCM interface scripts. It allows you to create a commit with an
229 empty commit message without using plumbing commands like
230 linkgit:git-commit-tree[1].
231
232 --cleanup=<mode>::
233 This option determines how the supplied commit message should be
234 cleaned up before committing. The '<mode>' can be `strip`,
235 `whitespace`, `verbatim`, `scissors` or `default`.
236 +
237 --
238 strip::
239 Strip leading and trailing empty lines, trailing whitespace,
240 commentary and collapse consecutive empty lines.
241 whitespace::
242 Same as `strip` except #commentary is not removed.
243 verbatim::
244 Do not change the message at all.
245 scissors::
246 Same as `whitespace` except that everything from (and including)
247 the line found below is truncated, if the message is to be edited.
248 "`#`" can be customized with core.commentChar.
249
250 # ------------------------ >8 ------------------------
251
252 default::
253 Same as `strip` if the message is to be edited.
254 Otherwise `whitespace`.
255 --
256 +
257 The default can be changed by the `commit.cleanup` configuration
258 variable (see linkgit:git-config[1]).
259
260 -e::
261 --edit::
262 The message taken from file with `-F`, command line with
263 `-m`, and from commit object with `-C` are usually used as
264 the commit log message unmodified. This option lets you
265 further edit the message taken from these sources.
266
267 --no-edit::
268 Use the selected commit message without launching an editor.
269 For example, `git commit --amend --no-edit` amends a commit
270 without changing its commit message.
271
272 --amend::
273 Replace the tip of the current branch by creating a new
274 commit. The recorded tree is prepared as usual (including
275 the effect of the `-i` and `-o` options and explicit
276 pathspec), and the message from the original commit is used
277 as the starting point, instead of an empty message, when no
278 other message is specified from the command line via options
279 such as `-m`, `-F`, `-c`, etc. The new commit has the same
280 parents and author as the current one (the `--reset-author`
281 option can countermand this).
282 +
283 --
284 It is a rough equivalent for:
285 ------
286 $ git reset --soft HEAD^
287 $ ... do something else to come up with the right tree ...
288 $ git commit -c ORIG_HEAD
289
290 ------
291 but can be used to amend a merge commit.
292 --
293 +
294 You should understand the implications of rewriting history if you
295 amend a commit that has already been published. (See the "RECOVERING
296 FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
297
298 --no-post-rewrite::
299 Bypass the post-rewrite hook.
300
301 -i::
302 --include::
303 Before making a commit out of staged contents so far,
304 stage the contents of paths given on the command line
305 as well. This is usually not what you want unless you
306 are concluding a conflicted merge.
307
308 -o::
309 --only::
310 Make a commit by taking the updated working tree contents
311 of the paths specified on the
312 command line, disregarding any contents that have been
313 staged for other paths. This is the default mode of operation of
314 'git commit' if any paths are given on the command line,
315 in which case this option can be omitted.
316 If this option is specified together with `--amend`, then
317 no paths need to be specified, which can be used to amend
318 the last commit without committing changes that have
319 already been staged. If used together with `--allow-empty`
320 paths are also not required, and an empty commit will be created.
321
322 --pathspec-from-file=<file>::
323 Pathspec is passed in `<file>` instead of commandline args. If
324 `<file>` is exactly `-` then standard input is used. Pathspec
325 elements are separated by LF or CR/LF. Pathspec elements can be
326 quoted as explained for the configuration variable `core.quotePath`
327 (see linkgit:git-config[1]). See also `--pathspec-file-nul` and
328 global `--literal-pathspecs`.
329
330 --pathspec-file-nul::
331 Only meaningful with `--pathspec-from-file`. Pathspec elements are
332 separated with NUL character and all other characters are taken
333 literally (including newlines and quotes).
334
335 -u[<mode>]::
336 --untracked-files[=<mode>]::
337 Show untracked files.
338 +
339 --
340 The mode parameter is optional (defaults to 'all'), and is used to
341 specify the handling of untracked files; when -u is not used, the
342 default is 'normal', i.e. show untracked files and directories.
343
344 The possible options are:
345
346 - 'no' - Show no untracked files
347 - 'normal' - Shows untracked files and directories
348 - 'all' - Also shows individual files in untracked directories.
349
350 The default can be changed using the status.showUntrackedFiles
351 configuration variable documented in linkgit:git-config[1].
352 --
353
354 -v::
355 --verbose::
356 Show unified diff between the HEAD commit and what
357 would be committed at the bottom of the commit message
358 template to help the user describe the commit by reminding
359 what changes the commit has.
360 Note that this diff output doesn't have its
361 lines prefixed with '#'. This diff will not be a part
362 of the commit message. See the `commit.verbose` configuration
363 variable in linkgit:git-config[1].
364 +
365 If specified twice, show in addition the unified diff between
366 what would be committed and the worktree files, i.e. the unstaged
367 changes to tracked files.
368
369 -q::
370 --quiet::
371 Suppress commit summary message.
372
373 --dry-run::
374 Do not create a commit, but show a list of paths that are
375 to be committed, paths with local changes that will be left
376 uncommitted and paths that are untracked.
377
378 --status::
379 Include the output of linkgit:git-status[1] in the commit
380 message template when using an editor to prepare the commit
381 message. Defaults to on, but can be used to override
382 configuration variable commit.status.
383
384 --no-status::
385 Do not include the output of linkgit:git-status[1] in the
386 commit message template when using an editor to prepare the
387 default commit message.
388
389 -S[<keyid>]::
390 --gpg-sign[=<keyid>]::
391 --no-gpg-sign::
392 GPG-sign commits. The `keyid` argument is optional and
393 defaults to the committer identity; if specified, it must be
394 stuck to the option without a space. `--no-gpg-sign` is useful to
395 countermand both `commit.gpgSign` configuration variable, and
396 earlier `--gpg-sign`.
397
398 \--::
399 Do not interpret any more arguments as options.
400
401 <pathspec>...::
402 When pathspec is given on the command line, commit the contents of
403 the files that match the pathspec without recording the changes
404 already added to the index. The contents of these files are also
405 staged for the next commit on top of what have been staged before.
406 +
407 For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
408
409 EXAMPLES
410 --------
411 When recording your own work, the contents of modified files in
412 your working tree are temporarily stored to a staging area
413 called the "index" with 'git add'. A file can be
414 reverted back, only in the index but not in the working tree,
415 to that of the last commit with `git restore --staged <file>`,
416 which effectively reverts 'git add' and prevents the changes to
417 this file from participating in the next commit. After building
418 the state to be committed incrementally with these commands,
419 `git commit` (without any pathname parameter) is used to record what
420 has been staged so far. This is the most basic form of the
421 command. An example:
422
423 ------------
424 $ edit hello.c
425 $ git rm goodbye.c
426 $ git add hello.c
427 $ git commit
428 ------------
429
430 Instead of staging files after each individual change, you can
431 tell `git commit` to notice the changes to the files whose
432 contents are tracked in
433 your working tree and do corresponding `git add` and `git rm`
434 for you. That is, this example does the same as the earlier
435 example if there is no other change in your working tree:
436
437 ------------
438 $ edit hello.c
439 $ rm goodbye.c
440 $ git commit -a
441 ------------
442
443 The command `git commit -a` first looks at your working tree,
444 notices that you have modified hello.c and removed goodbye.c,
445 and performs necessary `git add` and `git rm` for you.
446
447 After staging changes to many files, you can alter the order the
448 changes are recorded in, by giving pathnames to `git commit`.
449 When pathnames are given, the command makes a commit that
450 only records the changes made to the named paths:
451
452 ------------
453 $ edit hello.c hello.h
454 $ git add hello.c hello.h
455 $ edit Makefile
456 $ git commit Makefile
457 ------------
458
459 This makes a commit that records the modification to `Makefile`.
460 The changes staged for `hello.c` and `hello.h` are not included
461 in the resulting commit. However, their changes are not lost --
462 they are still staged and merely held back. After the above
463 sequence, if you do:
464
465 ------------
466 $ git commit
467 ------------
468
469 this second commit would record the changes to `hello.c` and
470 `hello.h` as expected.
471
472 After a merge (initiated by 'git merge' or 'git pull') stops
473 because of conflicts, cleanly merged
474 paths are already staged to be committed for you, and paths that
475 conflicted are left in unmerged state. You would have to first
476 check which paths are conflicting with 'git status'
477 and after fixing them manually in your working tree, you would
478 stage the result as usual with 'git add':
479
480 ------------
481 $ git status | grep unmerged
482 unmerged: hello.c
483 $ edit hello.c
484 $ git add hello.c
485 ------------
486
487 After resolving conflicts and staging the result, `git ls-files -u`
488 would stop mentioning the conflicted path. When you are done,
489 run `git commit` to finally record the merge:
490
491 ------------
492 $ git commit
493 ------------
494
495 As with the case to record your own changes, you can use `-a`
496 option to save typing. One difference is that during a merge
497 resolution, you cannot use `git commit` with pathnames to
498 alter the order the changes are committed, because the merge
499 should be recorded as a single commit. In fact, the command
500 refuses to run when given pathnames (but see `-i` option).
501
502 COMMIT INFORMATION
503 ------------------
504
505 Author and committer information is taken from the following environment
506 variables, if set:
507
508 GIT_AUTHOR_NAME
509 GIT_AUTHOR_EMAIL
510 GIT_AUTHOR_DATE
511 GIT_COMMITTER_NAME
512 GIT_COMMITTER_EMAIL
513 GIT_COMMITTER_DATE
514
515 (nb "<", ">" and "\n"s are stripped)
516
517 The author and committer names are by convention some form of a personal name
518 (that is, the name by which other humans refer to you), although Git does not
519 enforce or require any particular form. Arbitrary Unicode may be used, subject
520 to the constraints listed above. This name has no effect on authentication; for
521 that, see the `credential.username` variable in linkgit:git-config[1].
522
523 In case (some of) these environment variables are not set, the information
524 is taken from the configuration items `user.name` and `user.email`, or, if not
525 present, the environment variable EMAIL, or, if that is not set,
526 system user name and the hostname used for outgoing mail (taken
527 from `/etc/mailname` and falling back to the fully qualified hostname when
528 that file does not exist).
529
530 The `author.name` and `committer.name` and their corresponding email options
531 override `user.name` and `user.email` if set and are overridden themselves by
532 the environment variables.
533
534 The typical usage is to set just the `user.name` and `user.email` variables;
535 the other options are provided for more complex use cases.
536
537 :git-commit: 1
538 include::date-formats.txt[]
539
540 DISCUSSION
541 ----------
542
543 Though not required, it's a good idea to begin the commit message
544 with a single short (less than 50 character) line summarizing the
545 change, followed by a blank line and then a more thorough description.
546 The text up to the first blank line in a commit message is treated
547 as the commit title, and that title is used throughout Git.
548 For example, linkgit:git-format-patch[1] turns a commit into email, and it uses
549 the title on the Subject line and the rest of the commit in the body.
550
551 include::i18n.txt[]
552
553 ENVIRONMENT AND CONFIGURATION VARIABLES
554 ---------------------------------------
555 The editor used to edit the commit log message will be chosen from the
556 `GIT_EDITOR` environment variable, the core.editor configuration variable, the
557 `VISUAL` environment variable, or the `EDITOR` environment variable (in that
558 order). See linkgit:git-var[1] for details.
559
560 HOOKS
561 -----
562 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
563 `post-commit` and `post-rewrite` hooks. See linkgit:githooks[5] for more
564 information.
565
566 FILES
567 -----
568
569 `$GIT_DIR/COMMIT_EDITMSG`::
570 This file contains the commit message of a commit in progress.
571 If `git commit` exits due to an error before creating a commit,
572 any commit message that has been provided by the user (e.g., in
573 an editor session) will be available in this file, but will be
574 overwritten by the next invocation of `git commit`.
575
576 SEE ALSO
577 --------
578 linkgit:git-add[1],
579 linkgit:git-rm[1],
580 linkgit:git-mv[1],
581 linkgit:git-merge[1],
582 linkgit:git-commit-tree[1]
583
584 GIT
585 ---
586 Part of the linkgit:git[1] suite