t1510: setup case #29
[git.git] / Documentation / git-commit.txt
blob42fb1f57b21d7c355d3df6be07329c478786a9a7
1 git-commit(1)
2 =============
4 NAME
5 ----
6 git-commit - Record changes to the repository
8 SYNOPSIS
9 --------
10 [verse]
11 'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
12            [(-c | -C) <commit>] [-F <file> | -m <msg>] [--reset-author]
13            [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
14            [--date=<date>] [--cleanup=<mode>] [--status | --no-status] [--]
15            [[-i | -o ]<file>...]
17 DESCRIPTION
18 -----------
19 Stores the current contents of the index in a new commit along
20 with a log message from the user describing the changes.
22 The content to be added can be specified in several ways:
24 1. by using 'git add' to incrementally "add" changes to the
25    index before using the 'commit' command (Note: even modified
26    files must be "added");
28 2. by using 'git rm' to remove files from the working tree
29    and the index, again before using the 'commit' command;
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
33    record the current content of the listed files (which must already
34    be known to git);
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;
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
44    operation.  Currently, this is done by invoking 'git add --interactive'.
46 The `--dry-run` option can be used to obtain a
47 summary of what is included by any of the above for the next
48 commit by giving the same set of parameters (options and paths).
50 If you make a commit and then find a mistake immediately after
51 that, you can recover from it with 'git reset'.
54 OPTIONS
55 -------
56 -a::
57 --all::
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.
62 -C <commit>::
63 --reuse-message=<commit>::
64         Take an existing commit object, and reuse the log message
65         and the authorship information (including the timestamp)
66         when creating the commit.
68 -c <commit>::
69 --reedit-message=<commit>::
70         Like '-C', but with '-c' the editor is invoked, so that
71         the user can further edit the commit message.
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.
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`.
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`.
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.
92 -F <file>::
93 --file=<file>::
94         Take the commit message from the given file.  Use '-' to
95         read the message from the standard input.
97 --author=<author>::
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.
104 --date=<date>::
105         Override the author date used in the commit.
107 -m <msg>::
108 --message=<msg>::
109         Use the given <msg> as the commit message.
111 -t <file>::
112 --template=<file>::
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
116         the `-m` or `-F` options, this option has no effect. This
117         overrides the `commit.template` configuration variable.
119 -s::
120 --signoff::
121         Add Signed-off-by line by the committer at the end of the commit
122         log message.
124 -n::
125 --no-verify::
126         This option bypasses the pre-commit and commit-msg hooks.
127         See also linkgit:githooks[5].
129 --allow-empty::
130         Usually recording a commit that has the exact same tree as its
131         sole parent commit is a mistake, and the command prevents you
132         from making such a commit.  This option bypasses the safety, and
133         is primarily for use by foreign SCM interface scripts.
135 --allow-empty-message::
136        Like --allow-empty this command is primarily for use by foreign
137        SCM interface scripts. It allows you to create a commit with an
138        empty commit message without using plumbing commands like
139        linkgit:git-commit-tree[1].
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.
151 -e::
152 --edit::
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.
158 --amend::
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.
169 It is a rough equivalent for:
170 ------
171         $ git reset --soft HEAD^
172         $ ... do something else to come up with the right tree ...
173         $ git commit -c ORIG_HEAD
175 ------
176 but can be used to amend a merge commit.
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].)
183 -i::
184 --include::
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.
190 -o::
191 --only::
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
195         'git commit' if any paths are given on the command line,
196         in which case this option can be omitted.
197         If this option is specified together with '--amend', then
198         no paths need to be specified, which can be used to amend
199         the last commit without committing changes that have
200         already been staged.
202 -u[<mode>]::
203 --untracked-files[=<mode>]::
204         Show untracked files (Default: 'all').
206 The mode parameter is optional, and is used to specify
207 the handling of untracked files.
209 The possible options are:
211         - 'no'     - Show no untracked files
212         - 'normal' - Shows untracked files and directories
213         - 'all'    - Also shows individual files in untracked directories.
215 See linkgit:git-config[1] for configuration variable
216 used to change the default for when the option is not
217 specified.
219 -v::
220 --verbose::
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 '#'.
226 -q::
227 --quiet::
228         Suppress commit summary message.
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.
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.
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.
246 \--::
247         Do not interpret any more arguments as options.
249 <file>...::
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.
256 :git-commit: 1
257 include::date-formats.txt[]
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
263 called the "index" with 'git add'.  A file can be
264 reverted back, only in the index but not in the working tree,
265 to that of the last commit with `git reset HEAD -- <file>`,
266 which effectively reverts 'git add' and prevents the changes to
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
270 has been staged so far.  This is the most basic form of the
271 command.  An example:
273 ------------
274 $ edit hello.c
275 $ git rm goodbye.c
276 $ git add hello.c
277 $ git commit
278 ------------
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:
287 ------------
288 $ edit hello.c
289 $ rm goodbye.c
290 $ git commit -a
291 ------------
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.
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:
302 ------------
303 $ edit hello.c hello.h
304 $ git add hello.c hello.h
305 $ edit Makefile
306 $ git commit Makefile
307 ------------
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:
315 ------------
316 $ git commit
317 ------------
319 this second commit would record the changes to `hello.c` and
320 `hello.h` as expected.
322 After a merge (initiated by 'git merge' or 'git pull') stops
323 because of conflicts, cleanly merged
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
326 check which paths are conflicting with 'git status'
327 and after fixing them manually in your working tree, you would
328 stage the result as usual with 'git add':
330 ------------
331 $ git status | grep unmerged
332 unmerged: hello.c
333 $ edit hello.c
334 $ git add hello.c
335 ------------
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:
341 ------------
342 $ git commit
343 ------------
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).
353 DISCUSSION
354 ----------
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.
362 include::i18n.txt[]
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
369 order).  See linkgit:git-var[1] for details.
371 HOOKS
372 -----
373 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
374 and `post-commit` hooks.  See linkgit:githooks[5] for more
375 information.
378 SEE ALSO
379 --------
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]
386 Author
387 ------
388 Written by Linus Torvalds <torvalds@osdl.org> and
389 Junio C Hamano <gitster@pobox.com>
394 Part of the linkgit:git[1] suite