Google Git
Sign in
chromium / external / gitster / git-htmldocs / f31d9f5bcd0a1c236d8277df39c74927917ffb8f / . / git-commit.html
blob: 06757e28919a69b4f88e61132b89ed3faedcccfc [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]6<meta name="generator" content="AsciiDoc 7.0.2" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-commit(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-commit(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-commit -
269 Record your changes
270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano235a91e2006-01-07 01:13:58[diff] [blame]275<div class="verseblock">
Junio C Hamano6697ac52006-02-14 08:00:23[diff] [blame]276<div class="content"><em>git-commit</em> [-a] [-s] [-v] [(-c | -C) &lt;commit&gt; | -F &lt;file&gt; | -m &lt;msg&gt;]
Junio C Hamanobfe9e752006-04-05 21:43:28[diff] [blame]277 [--no-verify] [--amend] [-e] [--author &lt;author&gt;]
278 [--] [[-i | -o ]&lt;file&gt;&#8230;]</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]279</div>
280<h2>DESCRIPTION</h2>
281<div class="sectionbody">
282<p>Updates the index file for given paths, or all modified files if
283<em>-a</em> is specified, and makes a commit object. The command
284VISUAL and EDITOR environment variables to edit the commit log
285message.</p>
Junio C Hamano2b135272006-03-18 07:45:42[diff] [blame]286<p>Several environment variable are used during commits. They are
287documented in <a href="git-commit-tree.html">git-commit-tree(1)</a>.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]288<p>This command can run <tt>commit-msg</tt>, <tt>pre-commit</tt>, and
289<tt>post-commit</tt> hooks. See <a href="hooks.html">hooks</a> for more
290information.</p>
291</div>
292<h2>OPTIONS</h2>
293<div class="sectionbody">
294<dl>
295<dt>
296-a|--all
297</dt>
298<dd>
299<p>
Junio C Hamano74e8a2d2006-01-14 03:58:41[diff] [blame]300 Update all paths in the index file. This flag notices
301 files that have been modified and deleted, but new files
Junio C Hamanoa6331a82006-01-22 07:50:33[diff] [blame]302 you have not told git about are not affected.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]303</p>
304</dd>
305<dt>
306-c or -C &lt;commit&gt;
307</dt>
308<dd>
309<p>
310 Take existing commit object, and reuse the log message
311 and the authorship information (including the timestamp)
312 when creating the commit. With <em>-C</em>, the editor is not
313 invoked; with <em>-c</em> the user can further edit the commit
314 message.
315</p>
316</dd>
317<dt>
318-F &lt;file&gt;
319</dt>
320<dd>
321<p>
322 Take the commit message from the given file. Use <em>-</em> to
323 read the message from the standard input.
324</p>
325</dd>
326<dt>
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]327--author &lt;author&gt;
328</dt>
329<dd>
330<p>
331 Override the author name used in the commit. Use
332 <tt>A U Thor &lt;author@example.com&gt;</tt> format.
333</p>
334</dd>
335<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]336-m &lt;msg&gt;
337</dt>
338<dd>
339<p>
340 Use the given &lt;msg&gt; as the commit message.
341</p>
342</dd>
343<dt>
344-s|--signoff
345</dt>
346<dd>
347<p>
348 Add Signed-off-by line at the end of the commit message.
349</p>
350</dd>
351<dt>
352-v|--verify
353</dt>
354<dd>
355<p>
356 Look for suspicious lines the commit introduces, and
357 abort committing if there is one. The definition of
358 <em>suspicious lines</em> is currently the lines that has
359 trailing whitespaces, and the lines whose indentation
360 has a SP character immediately followed by a TAB
361 character. This is the default.
362</p>
363</dd>
364<dt>
365-n|--no-verify
366</dt>
367<dd>
368<p>
369 The opposite of <tt>--verify</tt>.
370</p>
371</dd>
372<dt>
373-e|--edit
374</dt>
375<dd>
376<p>
377 The message taken from file with <tt>-F</tt>, command line with
378 <tt>-m</tt>, and from file with <tt>-C</tt> are usually used as the
379 commit log message unmodified. This option lets you
380 further edit the message taken from these sources.
381</p>
382</dd>
383<dt>
Junio C Hamanobfe9e752006-04-05 21:43:28[diff] [blame]384--amend
385</dt>
386<dd>
387<p>
388 Used to amend the tip of the current branch. Prepare the tree
389 object you would want to replace the latest commit as usual
390 (this includes the usual -i/-o and explicit paths), and the
391 commit log editor is seeded with the commit message from the
392 tip of the current branch. The commit you create replaces the
393 current tip &#8212; if it was a merge, it will have the parents of
394 the current tip as parents &#8212; so the current top commit is
395 discarded.
396</p>
397<p>It is a rough equivalent for:</p>
398<div class="listingblock">
399<div class="content">
400<pre><tt> $ git reset --soft HEAD^
401 $ ... do something else to come up with the right tree ...
Junio C Hamano47ea30e2006-04-05 23:08:03[diff] [blame]402 $ git commit -c ORIG_HEAD
403</tt></pre>
Junio C Hamanobfe9e752006-04-05 21:43:28[diff] [blame]404</div></div>
405<p>but can be used to amend a merge commit.</p>
406</dd>
407<dt>
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]408-i|--include
409</dt>
410<dd>
411<p>
412 Instead of committing only the files specified on the
413 command line, update them in the index file and then
414 commit the whole index. This is the traditional
415 behaviour.
416</p>
417</dd>
418<dt>
Junio C Hamano6697ac52006-02-14 08:00:23[diff] [blame]419-o|--only
420</dt>
421<dd>
422<p>
423 Commit only the files specified on the command line.
424 This format cannot be used during a merge, nor when the
425 index and the latest commit does not match on the
426 specified paths to avoid confusion.
427</p>
428</dd>
429<dt>
Junio C Hamano1bb569e2006-05-05 23:14:25[diff] [blame]430--
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]431</dt>
432<dd>
433<p>
434 Do not interpret any more arguments as options.
435</p>
436</dd>
437<dt>
438&lt;file&gt;&#8230;
439</dt>
440<dd>
441<p>
Junio C Hamano6697ac52006-02-14 08:00:23[diff] [blame]442 Files to be committed. The meaning of these is
443 different between <tt>--include</tt> and <tt>--only</tt>. Without
444 either, it defaults <tt>--only</tt> semantics.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]445</p>
446</dd>
447</dl>
448<p>If you make a commit and then found a mistake immediately after
449that, you can recover from it with <a href="git-reset.html">git-reset(1)</a>.</p>
450</div>
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]451<h2>Discussion</h2>
452<div class="sectionbody">
453<p><tt>git commit</tt> without _any_ parameter commits the tree structure
454recorded by the current index file. This is a whole-tree commit
455even the command is invoked from a subdirectory.</p>
456<p><tt>git commit --include paths&#8230;</tt> is equivalent to</p>
457<div class="literalblock">
458<div class="content">
459<pre><tt>git update-index --remove paths...
460git commit</tt></pre>
461</div></div>
462<p>That is, update the specified paths to the index and then commit
463the whole tree.</p>
464<p><tt>git commit paths&#8230;</tt> largely bypasses the index file and
465commits only the changes made to the specified paths. It has
466however several safety valves to prevent confusion.</p>
467<ol>
468<li>
469<p>
470It refuses to run during a merge (i.e. when
471 <tt>$GIT_DIR/MERGE_HEAD</tt> exists), and reminds trained git users
472 that the traditional semantics now needs -i flag.
473</p>
474</li>
475<li>
476<p>
477It refuses to run if named <tt>paths&#8230;</tt> are different in HEAD
478 and the index (ditto about reminding). Added paths are OK.
479 This is because an earlier <tt>git diff</tt> (not <tt>git diff HEAD</tt>)
480 would have shown the differences since the last <tt>git
481 update-index paths&#8230;</tt> to the user, and an inexperienced user
482 may mistakenly think that the changes between the index and
483 the HEAD (i.e. earlier changes made before the last <tt>git
484 update-index paths&#8230;</tt> was done) are not being committed.
485</p>
486</li>
487<li>
488<p>
489It reads HEAD commit into a temporary index file, updates the
490 specified <tt>paths&#8230;</tt> and makes a commit. At the same time,
491 the real index file is also updated with the same <tt>paths&#8230;</tt>.
492</p>
493</li>
494</ol>
495<p><tt>git commit --all</tt> updates the index file with _all_ changes to
496the working tree, and makes a whole-tree commit, regardless of
497which subdirectory the command is invoked in.</p>
498</div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]499<h2>Author</h2>
500<div class="sectionbody">
501<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt; and
502Junio C Hamano &lt;junkio@cox.net&gt;</p>
503</div>
504<h2>GIT</h2>
505<div class="sectionbody">
506<p>Part of the <a href="git.html">git(7)</a> suite</p>
507</div>
508<div id="footer">
509<div id="footer-text">
Junio C Hamano1bb569e2006-05-05 23:14:25[diff] [blame]510Last updated 05-May-2006 23:14:12 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]511</div>
512</div>
513</body>
514</html>