1git-commit(1) 2============= 3 4NAME 5---- 6git-commit - Record changes to the repository 7 8SYNOPSIS 9-------- 10[verse] 11'git-commit' [-a | --interactive] [-s] [-v] [-u] [--amend] 12 [(-c | -C) <commit>] [-F <file> | -m <msg>] 13 [--allow-empty] [--no-verify] [-e] [--author=<author>] 14 [--cleanup=<mode>] [--] [[-i | -o ]<file>...] 15 16DESCRIPTION 17----------- 18Use 'git commit' to store the current contents of the index in a new 19commit along with a log message describing the changes you have made. 20 21The content to be added can be specified in several ways: 22 231. by using linkgit:git-add[1] to incrementally "add" changes to the 24 index before using the 'commit' command (Note: even modified 25 files must be "added"); 26 272. by using linkgit:git-rm[1] to remove files from the working tree 28 and the index, again before using the 'commit' command; 29 303. 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; 33 344. by using the -a switch with the 'commit' command to automatically 35 "add" changes from all known files (i.e. all files that are already 36 listed in the index) and to automatically "rm" files in the index 37 that have been removed from the working tree, and then perform the 38 actual commit; 39 405. by using the --interactive switch with the 'commit' command to decide one 41 by one which files should be part of the commit, before finalizing the 42 operation. Currently, this is done by invoking `git-add --interactive`. 43 44The linkgit:git-status[1] command can be used to obtain a 45summary of what is included by any of the above for the next 46commit by giving the same set of parameters you would give to 47this command. 48 49If you make a commit and then found a mistake immediately after 50that, you can recover from it with linkgit:git-reset[1]. 51 52 53OPTIONS 54------- 55-a|--all:: 56 Tell the command to automatically stage files that have 57 been modified and deleted, but new files you have not 58 told git about are not affected. 59 60-C <commit>|--reuse-message=<commit>:: 61 Take an existing commit object, and reuse the log message 62 and the authorship information (including the timestamp) 63 when creating the commit. 64 65-c <commit>|--reedit-message=<commit>:: 66 Like '-C', but with '-c' the editor is invoked, so that 67 the user can further edit the commit message. 68 69-F <file>|--file=<file>:: 70 Take the commit message from the given file. Use '-' to 71 read the message from the standard input. 72 73--author=<author>:: 74 Override the author name used in the commit. Use 75 `A U Thor <author@example.com>` format. 76 77-m <msg>|--message=<msg>:: 78 Use the given <msg> as the commit message. 79 80-t <file>|--template=<file>:: 81 Use the contents of the given file as the initial version 82 of the commit message. The editor is invoked and you can 83 make subsequent changes. If a message is specified using 84 the `-m` or `-F` options, this option has no effect. This 85 overrides the `commit.template` configuration variable. 86 87-s|--signoff:: 88 Add Signed-off-by line at the end of the commit message. 89 90-n|--no-verify:: 91 This option bypasses the pre-commit and commit-msg hooks. 92 See also linkgit:githooks[5][hooks]. 93 94--allow-empty:: 95 Usually recording a commit that has the exact same tree as its 96 sole parent commit is a mistake, and the command prevents you 97 from making such a commit. This option bypasses the safety, and 98 is primarily for use by foreign scm interface scripts. 99 100--cleanup=<mode>:: 101 This option sets how the commit message is cleaned up. 102 The '<mode>' can be one of 'verbatim', 'whitespace', 'strip', 103 and 'default'. The 'default' mode will strip leading and 104 trailing empty lines and #commentary from the commit message 105 only if the message is to be edited. Otherwise only whitespace 106 removed. The 'verbatim' mode does not change message at all, 107 'whitespace' removes just leading/trailing whitespace lines 108 and 'strip' removes both whitespace and commentary. 109 110-e|--edit:: 111 The message taken from file with `-F`, command line with 112 `-m`, and from file with `-C` are usually used as the 113 commit log message unmodified. This option lets you 114 further edit the message taken from these sources. 115 116--amend:: 117 Used to amend the tip of the current branch. Prepare the tree 118 object you would want to replace the latest commit as usual 119 (this includes the usual -i/-o and explicit paths), and the 120 commit log editor is seeded with the commit message from the 121 tip of the current branch. The commit you create replaces the 122 current tip -- if it was a merge, it will have the parents of 123 the current tip as parents -- so the current top commit is 124 discarded. 125+ 126-- 127It is a rough equivalent for: 128------ 129 $ git reset --soft HEAD^ 130 $ ... do something else to come up with the right tree ... 131 $ git commit -c ORIG_HEAD 132 133------ 134but can be used to amend a merge commit. 135-- 136 137-i|--include:: 138 Before making a commit out of staged contents so far, 139 stage the contents of paths given on the command line 140 as well. This is usually not what you want unless you 141 are concluding a conflicted merge. 142 143-o|--only:: 144 Make a commit only from the paths specified on the 145 command line, disregarding any contents that have been 146 staged so far. This is the default mode of operation of 147 'git commit' if any paths are given on the command line, 148 in which case this option can be omitted. 149 If this option is specified together with '--amend', then 150 no paths need be specified, which can be used to amend 151 the last commit without committing changes that have 152 already been staged. 153 154-u|--untracked-files:: 155 Show all untracked files, also those in uninteresting 156 directories, in the "Untracked files:" section of commit 157 message template. Without this option only its name and 158 a trailing slash are displayed for each untracked 159 directory. 160 161-v|--verbose:: 162 Show unified diff between the HEAD commit and what 163 would be committed at the bottom of the commit message 164 template. Note that this diff output doesn't have its 165 lines prefixed with '#'. 166 167-q|--quiet:: 168 Suppress commit summary message. 169 170\--:: 171 Do not interpret any more arguments as options. 172 173<file>...:: 174 When files are given on the command line, the command 175 commits the contents of the named files, without 176 recording the changes already staged. The contents of 177 these files are also staged for the next commit on top 178 of what have been staged before. 179 180 181EXAMPLES 182-------- 183When recording your own work, the contents of modified files in 184your working tree are temporarily stored to a staging area 185called the "index" with linkgit:git-add[1]. A file can be 186reverted back, only in the index but not in the working tree, 187to that of the last commit with `git-reset HEAD -- <file>`, 188which effectively reverts `git-add` and prevents the changes to 189this file from participating in the next commit. After building 190the state to be committed incrementally with these commands, 191`git commit` (without any pathname parameter) is used to record what 192has been staged so far. This is the most basic form of the 193command. An example: 194 195------------ 196$ edit hello.c 197$ git rm goodbye.c 198$ git add hello.c 199$ git commit 200------------ 201 202Instead of staging files after each individual change, you can 203tell `git commit` to notice the changes to the files whose 204contents are tracked in 205your working tree and do corresponding `git add` and `git rm` 206for you. That is, this example does the same as the earlier 207example if there is no other change in your working tree: 208 209------------ 210$ edit hello.c 211$ rm goodbye.c 212$ git commit -a 213------------ 214 215The command `git commit -a` first looks at your working tree, 216notices that you have modified hello.c and removed goodbye.c, 217and performs necessary `git add` and `git rm` for you. 218 219After staging changes to many files, you can alter the order the 220changes are recorded in, by giving pathnames to `git commit`. 221When pathnames are given, the command makes a commit that 222only records the changes made to the named paths: 223 224------------ 225$ edit hello.c hello.h 226$ git add hello.c hello.h 227$ edit Makefile 228$ git commit Makefile 229------------ 230 231This makes a commit that records the modification to `Makefile`. 232The changes staged for `hello.c` and `hello.h` are not included 233in the resulting commit. However, their changes are not lost -- 234they are still staged and merely held back. After the above 235sequence, if you do: 236 237------------ 238$ git commit 239------------ 240 241this second commit would record the changes to `hello.c` and 242`hello.h` as expected. 243 244After a merge (initiated by either linkgit:git-merge[1] or 245linkgit:git-pull[1]) stops because of conflicts, cleanly merged 246paths are already staged to be committed for you, and paths that 247conflicted are left in unmerged state. You would have to first 248check which paths are conflicting with linkgit:git-status[1] 249and after fixing them manually in your working tree, you would 250stage the result as usual with linkgit:git-add[1]: 251 252------------ 253$ git status | grep unmerged 254unmerged: hello.c 255$ edit hello.c 256$ git add hello.c 257------------ 258 259After resolving conflicts and staging the result, `git ls-files -u` 260would stop mentioning the conflicted path. When you are done, 261run `git commit` to finally record the merge: 262 263------------ 264$ git commit 265------------ 266 267As with the case to record your own changes, you can use `-a` 268option to save typing. One difference is that during a merge 269resolution, you cannot use `git commit` with pathnames to 270alter the order the changes are committed, because the merge 271should be recorded as a single commit. In fact, the command 272refuses to run when given pathnames (but see `-i` option). 273 274 275DISCUSSION 276---------- 277 278Though not required, it's a good idea to begin the commit message 279with a single short (less than 50 character) line summarizing the 280change, followed by a blank line and then a more thorough description. 281Tools that turn commits into email, for example, use the first line 282on the Subject: line and the rest of the commit in the body. 283 284include::i18n.txt[] 285 286ENVIRONMENT AND CONFIGURATION VARIABLES 287--------------------------------------- 288The editor used to edit the commit log message will be chosen from the 289GIT_EDITOR environment variable, the core.editor configuration variable, the 290VISUAL environment variable, or the EDITOR environment variable (in that 291order). 292 293HOOKS 294----- 295This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`, 296and `post-commit` hooks. See linkgit:githooks[5][hooks] for more 297information. 298 299 300SEE ALSO 301-------- 302linkgit:git-add[1], 303linkgit:git-rm[1], 304linkgit:git-mv[1], 305linkgit:git-merge[1], 306linkgit:git-commit-tree[1] 307 308Author 309------ 310Written by Linus Torvalds <torvalds@osdl.org> and 311Junio C Hamano <junkio@cox.net> 312 313 314GIT 315--- 316Part of the linkgit:git[1] suite