blob: 09711640cd6576a2b45bc8ce424933277d1230ab [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231<!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 Hamanoba4b9282008-07-06 05:20:316<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano1a4e8412005-12-27 08:17:237<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
Junio C Hamanoba4b9282008-07-06 05:20:3119a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano1a4e8412005-12-27 08:17:2326
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:3147h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:2348 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano1a4e8412005-12-27 08:17:2351 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:3153h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano1a4e8412005-12-27 08:17:2359
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:3183 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:2384}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano1a4e8412005-12-27 08:17:23155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31164
165div.attribution {
Junio C Hamano1a4e8412005-12-27 08:17:23166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano1a4e8412005-12-27 08:17:23171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31214div.olist2 ol {
Junio C Hamano1a4e8412005-12-27 08:17:23215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31219 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano1a4e8412005-12-27 08:17:23236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano1a4e8412005-12-27 08:17:23275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23306</style>
307<title>git-commit-tree(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-commit-tree(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-commit-tree -
Junio C Hamano7c73c662007-01-19 00:37:50317 Create a new commit object
Junio C Hamano1a4e8412005-12-27 08:17:23318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31323<div class="para"><p><em>git commit-tree</em> &lt;tree&gt; [-p &lt;parent commit&gt;]* &lt; changelog</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23324</div>
Junio C Hamanoba4b9282008-07-06 05:20:31325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23326<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31327<div class="para"><p>This is usually not what an end user wants to run directly. See
328<a href="git-commit.html">git-commit(1)</a> instead.</p></div>
329<div class="para"><p>Creates a new commit object based on the provided tree object and
Junio C Hamanofaa1e502008-08-10 03:55:58330emits the new commit object id on stdout.</p></div>
331<div class="para"><p>A commit object may have any number of parents. With exactly one
332parent, it is an ordinary commit. Having more than one parent makes
333the commit a merge between several lines of history. Initial (root)
334commits have no parents.</p></div>
Junio C Hamanoba4b9282008-07-06 05:20:31335<div class="para"><p>While a tree represents a particular directory state of a working
Junio C Hamano1a4e8412005-12-27 08:17:23336directory, a commit represents that state in "time", and explains how
Junio C Hamanoba4b9282008-07-06 05:20:31337to get there.</p></div>
338<div class="para"><p>Normally a commit would identify a new "HEAD" state, and while git
Junio C Hamano1a4e8412005-12-27 08:17:23339doesn't care where you save the note about that state, in practice we
340tend to just write the result to the file that is pointed at by
341<tt>.git/HEAD</tt>, so that we can always see what the last committed
Junio C Hamanoba4b9282008-07-06 05:20:31342state was.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23343</div>
Junio C Hamanoba4b9282008-07-06 05:20:31344<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23345<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31346<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23347<dt>
348&lt;tree&gt;
349</dt>
350<dd>
351<p>
352 An existing tree object
353</p>
354</dd>
355<dt>
356-p &lt;parent commit&gt;
357</dt>
358<dd>
359<p>
360 Each <em>-p</em> indicates the id of a parent commit object.
361</p>
362</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31363</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23364</div>
Junio C Hamanoba4b9282008-07-06 05:20:31365<h2 id="_commit_information">Commit Information</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23366<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31367<div class="para"><p>A commit encapsulates:</p></div>
368<div class="ilist"><ul>
Junio C Hamano1a4e8412005-12-27 08:17:23369<li>
370<p>
371all parent object ids
372</p>
373</li>
374<li>
375<p>
376author name, email and date
377</p>
378</li>
379<li>
380<p>
381committer name and email and the commit time.
382</p>
383</li>
Junio C Hamanoba4b9282008-07-06 05:20:31384</ul></div>
385<div class="para"><p>While parent object ids are provided on the command line, author and
Junio C Hamanoa6387422007-08-25 03:54:27386committer information is taken from the following environment variables,
Junio C Hamanoba4b9282008-07-06 05:20:31387if set:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23388<div class="literalblock">
389<div class="content">
390<pre><tt>GIT_AUTHOR_NAME
391GIT_AUTHOR_EMAIL
392GIT_AUTHOR_DATE
393GIT_COMMITTER_NAME
Junio C Hamano469d60e2007-04-29 18:30:34394GIT_COMMITTER_EMAIL
395GIT_COMMITTER_DATE
396EMAIL</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23397</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31398<div class="para"><p>(nb "&lt;", "&gt;" and "\n"s are stripped)</p></div>
399<div class="para"><p>In case (some of) these environment variables are not set, the information
Junio C Hamano1b11dcb2007-08-18 07:20:55400is taken from the configuration items user.name and user.email, or, if not
Junio C Hamanoba4b9282008-07-06 05:20:31401present, system user name and fully qualified hostname.</p></div>
402<div class="para"><p>A commit comment is read from stdin. If a changelog
403entry is not provided via "&lt;" redirection, <em>git-commit-tree</em> will just wait
404for one to be entered and terminated with ^D.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23405</div>
Junio C Hamanoba4b9282008-07-06 05:20:31406<h2 id="_diagnostics">Diagnostics</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23407<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31408<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23409<dt>
410You don't exist. Go away!
411</dt>
412<dd>
413<p>
414 The passwd(5) gecos field couldn't be read
415</p>
416</dd>
417<dt>
418Your parents must have hated you!
419</dt>
420<dd>
421<p>
Junio C Hamano37276192008-09-04 00:24:07422 The passwd(5) gecos field is longer than a giant static buffer.
Junio C Hamano1a4e8412005-12-27 08:17:23423</p>
424</dd>
425<dt>
426Your sysadmin must hate you!
427</dt>
428<dd>
429<p>
Junio C Hamano37276192008-09-04 00:24:07430 The passwd(5) name field is longer than a giant static buffer.
Junio C Hamano1a4e8412005-12-27 08:17:23431</p>
432</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31433</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23434</div>
Junio C Hamanoba4b9282008-07-06 05:20:31435<h2 id="_discussion">Discussion</h2>
Junio C Hamano775a0f42006-12-31 01:19:14436<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31437<div class="para"><p>At the core level, git is character encoding agnostic.</p></div>
438<div class="ilist"><ul>
Junio C Hamano775a0f42006-12-31 01:19:14439<li>
440<p>
441The pathnames recorded in the index and in the tree objects
442 are treated as uninterpreted sequences of non-NUL bytes.
443 What readdir(2) returns are what are recorded and compared
444 with the data git keeps track of, which in turn are expected
445 to be what lstat(2) and creat(2) accepts. There is no such
446 thing as pathname encoding translation.
447</p>
448</li>
449<li>
450<p>
Junio C Hamano54bf1e22008-12-20 06:30:11451The contents of the blob objects are uninterpreted sequences
Junio C Hamano775a0f42006-12-31 01:19:14452 of bytes. There is no encoding translation at the core
453 level.
454</p>
455</li>
456<li>
457<p>
Junio C Hamano54bf1e22008-12-20 06:30:11458The commit log messages are uninterpreted sequences of non-NUL
Junio C Hamano775a0f42006-12-31 01:19:14459 bytes.
460</p>
461</li>
Junio C Hamanoba4b9282008-07-06 05:20:31462</ul></div>
463<div class="para"><p>Although we encourage that the commit log messages are encoded
Junio C Hamano775a0f42006-12-31 01:19:14464in UTF-8, both the core and git Porcelain are designed not to
465force UTF-8 on projects. If all participants of a particular
466project find it more convenient to use legacy encodings, git
467does not forbid it. However, there are a few things to keep in
Junio C Hamanoba4b9282008-07-06 05:20:31468mind.</p></div>
469<div class="olist"><ol>
Junio C Hamano775a0f42006-12-31 01:19:14470<li>
471<p>
Junio C Hamano37276192008-09-04 00:24:07472<em>git-commit</em> and <em>git-commit-tree</em> issues
Junio C Hamano14b76482008-01-05 10:32:26473 a warning if the commit log message given to it does not look
Junio C Hamano775a0f42006-12-31 01:19:14474 like a valid UTF-8 string, unless you explicitly say your
475 project uses a legacy encoding. The way to say this is to
Junio C Hamano35bb3f62007-02-19 05:35:53476 have i18n.commitencoding in <tt>.git/config</tt> file, like this:
Junio C Hamano775a0f42006-12-31 01:19:14477</p>
478<div class="listingblock">
479<div class="content">
Junio C Hamano35bb3f62007-02-19 05:35:53480<pre><tt>[i18n]
Junio C Hamano775a0f42006-12-31 01:19:14481 commitencoding = ISO-8859-1</tt></pre>
482</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31483<div class="para"><p>Commit objects created with the above setting record the value
Junio C Hamano35bb3f62007-02-19 05:35:53484of <tt>i18n.commitencoding</tt> in its <tt>encoding</tt> header. This is to
Junio C Hamano775a0f42006-12-31 01:19:14485help other people who look at them later. Lack of this header
Junio C Hamanoba4b9282008-07-06 05:20:31486implies that the commit log message is encoded in UTF-8.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:14487</li>
488<li>
489<p>
Junio C Hamanoaa17c7c2008-11-03 04:36:58490<em>git-log</em>, <em>git-show</em>, <em>git-blame</em> and friends look at the
491 <tt>encoding</tt> header of a commit object, and try to re-code the
492 log message into UTF-8 unless otherwise specified. You can
Junio C Hamano775a0f42006-12-31 01:19:14493 specify the desired output encoding with
Junio C Hamano35bb3f62007-02-19 05:35:53494 <tt>i18n.logoutputencoding</tt> in <tt>.git/config</tt> file, like this:
Junio C Hamano775a0f42006-12-31 01:19:14495</p>
496<div class="listingblock">
497<div class="content">
Junio C Hamano35bb3f62007-02-19 05:35:53498<pre><tt>[i18n]
Junio C Hamano775a0f42006-12-31 01:19:14499 logoutputencoding = ISO-8859-1</tt></pre>
500</div></div>
Junio C Hamanoba4b9282008-07-06 05:20:31501<div class="para"><p>If you do not have this configuration variable, the value of
502<tt>i18n.commitencoding</tt> is used instead.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:14503</li>
Junio C Hamanoba4b9282008-07-06 05:20:31504</ol></div>
505<div class="para"><p>Note that we deliberately chose not to re-code the commit log
Junio C Hamano775a0f42006-12-31 01:19:14506message when a commit is made to force UTF-8 at the commit
507object level, because re-coding to UTF-8 is not necessarily a
Junio C Hamanoba4b9282008-07-06 05:20:31508reversible operation.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:14509</div>
Junio C Hamanoba4b9282008-07-06 05:20:31510<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23511<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31512<div class="para"><p><a href="git-write-tree.html">git-write-tree(1)</a></p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23513</div>
Junio C Hamanoba4b9282008-07-06 05:20:31514<h2 id="_author">Author</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23515<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31516<div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23517</div>
Junio C Hamanoba4b9282008-07-06 05:20:31518<h2 id="_documentation">Documentation</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23519<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31520<div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23521</div>
Junio C Hamanoba4b9282008-07-06 05:20:31522<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23523<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31524<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23525</div>
526<div id="footer">
527<div id="footer-text">
Junio C Hamano73d812c2009-07-01 02:33:06528Last updated 2009-07-01 02:30:45 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23529</div>
530</div>
531</body>
532</html>