packv4: nth_packed_object_sha1() packv4 support
[git/packv4.git] / Documentation / git-commit.txt
blobe54fb12103d4e4955f41532566cb4558432a97bb
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]
12            [(-c | -C) <commit> | -F <file> | -m <msg> | --amend]
13            [--no-verify] [-e] [--author <author>]
14            [--] [[-i | -o ]<file>...]
16 DESCRIPTION
17 -----------
18 Use 'git commit' to store the current contents of the index in a new
19 commit along with a log message describing the changes you have made.
21 The content to be added can be specified in several ways:
23 1. by using gitlink:git-add[1] to incrementally "add" changes to the
24    index before using the 'commit' command (Note: even modified
25    files must be "added");
27 2. by using gitlink:git-rm[1] to remove files from the working tree
28    and the index, again before using the 'commit' command;
30 3. 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;
34 4. 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;
40 5. 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`.
44 The gitlink:git-status[1] command can be used to obtain a
45 summary of what is included by any of the above for the next
46 commit by giving the same set of parameters you would give to
47 this command.
49 If you make a commit and then found a mistake immediately after
50 that, you can recover from it with gitlink:git-reset[1].
53 OPTIONS
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.
60 -c or -C <commit>::
61         Take existing commit object, and reuse the log message
62         and the authorship information (including the timestamp)
63         when creating the commit.  With '-C', the editor is not
64         invoked; with '-c' the user can further edit the commit
65         message.
67 -F <file>::
68         Take the commit message from the given file.  Use '-' to
69         read the message from the standard input.
71 --author <author>::
72         Override the author name used in the commit.  Use
73         `A U Thor <author@example.com>` format.
75 -m <msg>|--message=<msg>::
76         Use the given <msg> as the commit message.
78 -t <file>|--template=<file>::
79         Use the contents of the given file as the initial version
80         of the commit message. The editor is invoked and you can
81         make subsequent changes. If a message is specified using
82         the `-m` or `-F` options, this option has no effect. This
83         overrides the `commit.template` configuration variable.
85 -s|--signoff::
86         Add Signed-off-by line at the end of the commit message.
88 --no-verify::
89         This option bypasses the pre-commit hook.
90         See also link:hooks.html[hooks].
92 -e|--edit::
93         The message taken from file with `-F`, command line with
94         `-m`, and from file with `-C` are usually used as the
95         commit log message unmodified.  This option lets you
96         further edit the message taken from these sources.
98 --amend::
100         Used to amend the tip of the current branch. Prepare the tree
101         object you would want to replace the latest commit as usual
102         (this includes the usual -i/-o and explicit paths), and the
103         commit log editor is seeded with the commit message from the
104         tip of the current branch. The commit you create replaces the
105         current tip -- if it was a merge, it will have the parents of
106         the current tip as parents -- so the current top commit is
107         discarded.
110 It is a rough equivalent for:
111 ------
112         $ git reset --soft HEAD^
113         $ ... do something else to come up with the right tree ...
114         $ git commit -c ORIG_HEAD
116 ------
117 but can be used to amend a merge commit.
120 -i|--include::
121         Before making a commit out of staged contents so far,
122         stage the contents of paths given on the command line
123         as well.  This is usually not what you want unless you
124         are concluding a conflicted merge.
126 -u|--untracked-files::
127         Show all untracked files, also those in uninteresting
128         directories, in the "Untracked files:" section of commit
129         message template.  Without this option only its name and
130         a trailing slash are displayed for each untracked
131         directory.
133 -v|--verbose::
134         Show unified diff between the HEAD commit and what
135         would be committed at the bottom of the commit message
136         template.  Note that this diff output doesn't have its
137         lines prefixed with '#'.
139 -q|--quiet::
140         Suppress commit summary message.
142 \--::
143         Do not interpret any more arguments as options.
145 <file>...::
146         When files are given on the command line, the command
147         commits the contents of the named files, without
148         recording the changes already staged.  The contents of
149         these files are also staged for the next commit on top
150         of what have been staged before.
153 EXAMPLES
154 --------
155 When recording your own work, the contents of modified files in
156 your working tree are temporarily stored to a staging area
157 called the "index" with gitlink:git-add[1].  Removal
158 of a file is staged with gitlink:git-rm[1].  After building the
159 state to be committed incrementally with these commands, `git
160 commit` (without any pathname parameter) is used to record what
161 has been staged so far.  This is the most basic form of the
162 command.  An example:
164 ------------
165 $ edit hello.c
166 $ git rm goodbye.c
167 $ git add hello.c
168 $ git commit
169 ------------
171 Instead of staging files after each individual change, you can
172 tell `git commit` to notice the changes to the files whose
173 contents are tracked in
174 your working tree and do corresponding `git add` and `git rm`
175 for you.  That is, this example does the same as the earlier
176 example if there is no other change in your working tree:
178 ------------
179 $ edit hello.c
180 $ rm goodbye.c
181 $ git commit -a
182 ------------
184 The command `git commit -a` first looks at your working tree,
185 notices that you have modified hello.c and removed goodbye.c,
186 and performs necessary `git add` and `git rm` for you.
188 After staging changes to many files, you can alter the order the
189 changes are recorded in, by giving pathnames to `git commit`.
190 When pathnames are given, the command makes a commit that
191 only records the changes made to the named paths:
193 ------------
194 $ edit hello.c hello.h
195 $ git add hello.c hello.h
196 $ edit Makefile
197 $ git commit Makefile
198 ------------
200 This makes a commit that records the modification to `Makefile`.
201 The changes staged for `hello.c` and `hello.h` are not included
202 in the resulting commit.  However, their changes are not lost --
203 they are still staged and merely held back.  After the above
204 sequence, if you do:
206 ------------
207 $ git commit
208 ------------
210 this second commit would record the changes to `hello.c` and
211 `hello.h` as expected.
213 After a merge (initiated by either gitlink:git-merge[1] or
214 gitlink:git-pull[1]) stops because of conflicts, cleanly merged
215 paths are already staged to be committed for you, and paths that
216 conflicted are left in unmerged state.  You would have to first
217 check which paths are conflicting with gitlink:git-status[1]
218 and after fixing them manually in your working tree, you would
219 stage the result as usual with gitlink:git-add[1]:
221 ------------
222 $ git status | grep unmerged
223 unmerged: hello.c
224 $ edit hello.c
225 $ git add hello.c
226 ------------
228 After resolving conflicts and staging the result, `git ls-files -u`
229 would stop mentioning the conflicted path.  When you are done,
230 run `git commit` to finally record the merge:
232 ------------
233 $ git commit
234 ------------
236 As with the case to record your own changes, you can use `-a`
237 option to save typing.  One difference is that during a merge
238 resolution, you cannot use `git commit` with pathnames to
239 alter the order the changes are committed, because the merge
240 should be recorded as a single commit.  In fact, the command
241 refuses to run when given pathnames (but see `-i` option).
244 DISCUSSION
245 ----------
247 Though not required, it's a good idea to begin the commit message
248 with a single short (less than 50 character) line summarizing the
249 change, followed by a blank line and then a more thorough description.
250 Tools that turn commits into email, for example, use the first line
251 on the Subject: line and the rest of the commit in the body.
253 include::i18n.txt[]
255 ENVIRONMENT AND CONFIGURATION VARIABLES
256 ---------------------------------------
257 The editor used to edit the commit log message will be chosen from the
258 GIT_EDITOR environment variable, the core.editor configuration variable, the
259 VISUAL environment variable, or the EDITOR environment variable (in that
260 order).
262 HOOKS
263 -----
264 This command can run `commit-msg`, `pre-commit`, and
265 `post-commit` hooks.  See link:hooks.html[hooks] for more
266 information.
269 SEE ALSO
270 --------
271 gitlink:git-add[1],
272 gitlink:git-rm[1],
273 gitlink:git-mv[1],
274 gitlink:git-merge[1],
275 gitlink:git-commit-tree[1]
277 Author
278 ------
279 Written by Linus Torvalds <torvalds@osdl.org> and
280 Junio C Hamano <junkio@cox.net>
285 Part of the gitlink:git[7] suite