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