Autogenerated HTML docs for v1.1.2-g9e9b
[git.git] / git-commit-tree.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 7.0.1" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a { color: blue; }\r
20 a:visited { color: fuchsia; }\r
21 \r
22 em {\r
23   font-style: italic;\r
24 }\r
25 \r
26 strong {\r
27   font-weight: bold;\r
28 }\r
29 \r
30 tt {\r
31   color: navy;\r
32 }\r
33 \r
34 h1, h2, h3, h4, h5, h6 {\r
35   color: #527bbd;\r
36   font-family: sans-serif;\r
37   margin-top: 1.2em;\r
38   margin-bottom: 0.5em;\r
39   line-height: 1.3;\r
40 }\r
41 \r
42 h1 {\r
43   border-bottom: 2px solid silver;\r
44 }\r
45 h2 {\r
46   border-bottom: 2px solid silver;\r
47   padding-top: 0.5em;\r
48 }\r
49 \r
50 div.sectionbody {\r
51   font-family: serif;\r
52   margin-left: 0;\r
53 }\r
54 \r
55 hr {\r
56   border: 1px solid silver;\r
57 }\r
58 \r
59 p {\r
60   margin-top: 0.5em;\r
61   margin-bottom: 0.5em;\r
62 }\r
63 \r
64 pre {\r
65   padding: 0;\r
66   margin: 0;\r
67 }\r
68 \r
69 span#author {\r
70   color: #527bbd;\r
71   font-family: sans-serif;\r
72   font-weight: bold;\r
73   font-size: 1.2em;\r
74 }\r
75 span#email {\r
76 }\r
77 span#revision {\r
78   font-family: sans-serif;\r
79 }\r
80 \r
81 div#footer {\r
82   font-family: sans-serif;\r
83   font-size: small;\r
84   border-top: 2px solid silver;\r
85   padding-top: 0.5em;\r
86   margin-top: 4.0em;\r
87 }\r
88 div#footer-text {\r
89   float: left;\r
90   padding-bottom: 0.5em;\r
91 }\r
92 div#footer-badges {\r
93   float: right;\r
94   padding-bottom: 0.5em;\r
95 }\r
96 \r
97 div#preamble,\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
100 div.admonitionblock {\r
101   margin-right: 10%;\r
102   margin-top: 1.5em;\r
103   margin-bottom: 1.5em;\r
104 }\r
105 div.admonitionblock {\r
106   margin-top: 2.5em;\r
107   margin-bottom: 2.5em;\r
108 }\r
109 \r
110 div.content { /* Block element content. */\r
111   padding: 0;\r
112 }\r
113 \r
114 /* Block element titles. */\r
115 div.title, caption.title {\r
116   font-family: sans-serif;\r
117   font-weight: bold;\r
118   text-align: left;\r
119   margin-top: 1.0em;\r
120   margin-bottom: 0.5em;\r
121 }\r
122 div.title + * {\r
123   margin-top: 0;\r
124 }\r
125 \r
126 td div.title:first-child {\r
127   margin-top: 0.0em;\r
128 }\r
129 div.content div.title:first-child {\r
130   margin-top: 0.0em;\r
131 }\r
132 div.content + div.title {\r
133   margin-top: 0.0em;\r
134 }\r
135 \r
136 div.sidebarblock > div.content {\r
137   background: #ffffee;\r
138   border: 1px solid silver;\r
139   padding: 0.5em;\r
140 }\r
141 \r
142 div.listingblock > div.content {\r
143   border: 1px solid silver;\r
144   background: #f4f4f4;\r
145   padding: 0.5em;\r
146 }\r
147 \r
148 div.quoteblock > div.content {\r
149   padding-left: 2.0em;\r
150 }\r
151 div.quoteblock .attribution {\r
152   text-align: right;\r
153 }\r
154 \r
155 div.admonitionblock .icon {\r
156   vertical-align: top;\r
157   font-size: 1.1em;\r
158   font-weight: bold;\r
159   text-decoration: underline;\r
160   color: #527bbd;\r
161   padding-right: 0.5em;\r
162 }\r
163 div.admonitionblock td.content {\r
164   padding-left: 0.5em;\r
165   border-left: 2px solid silver;\r
166 }\r
167 \r
168 div.exampleblock > div.content {\r
169   border-left: 2px solid silver;\r
170   padding: 0.5em;\r
171 }\r
172 \r
173 div.verseblock div.content {\r
174   white-space: pre;\r
175 }\r
176 \r
177 div.imageblock div.content { padding-left: 0; }\r
178 div.imageblock img { border: 1px solid silver; }\r
179 span.image img { border-style: none; }\r
180 \r
181 dl {\r
182   margin-top: 0.8em;\r
183   margin-bottom: 0.8em;\r
184 }\r
185 dt {\r
186   margin-top: 0.5em;\r
187   margin-bottom: 0;\r
188   font-style: italic;\r
189 }\r
190 dd > *:first-child {\r
191   margin-top: 0;\r
192 }\r
193 \r
194 ul, ol {\r
195     list-style-position: outside;\r
196 }\r
197 ol.olist2 {\r
198   list-style-type: lower-alpha;\r
199 }\r
200 \r
201 div.tableblock > table {\r
202   border-color: #527bbd;\r
203   border-width: 3px;\r
204 }\r
205 thead {\r
206   font-family: sans-serif;\r
207   font-weight: bold;\r
208 }\r
209 tfoot {\r
210   font-weight: bold;\r
211 }\r
212 \r
213 div.hlist {\r
214   margin-top: 0.8em;\r
215   margin-bottom: 0.8em;\r
216 }\r
217 td.hlist1 {\r
218   vertical-align: top;\r
219   font-style: italic;\r
220   padding-right: 0.8em;\r
221 }\r
222 td.hlist2 {\r
223   vertical-align: top;\r
224 }\r
225 \r
226 @media print {\r
227   div#footer-badges { display: none; }\r
228 }\r
229 include::./stylesheets/xhtml11-manpage.css[]\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
231 \r
232 div.sidebar-content {\r
233   background: #ffffee;\r
234   border: 1px solid silver;\r
235   padding: 0.5em;\r
236 }\r
237 div.sidebar-title, div.image-title {\r
238   font-family: sans-serif;\r
239   font-weight: bold;\r
240   margin-top: 0.0em;\r
241   margin-bottom: 0.5em;\r
242 }\r
243 \r
244 div.listingblock div.content {\r
245   border: 1px solid silver;\r
246   background: #f4f4f4;\r
247   padding: 0.5em;\r
248 }\r
249 \r
250 div.quoteblock-content {\r
251   padding-left: 2.0em;\r
252 }\r
253 \r
254 div.exampleblock-content {\r
255   border-left: 2px solid silver;\r
256   padding-left: 0.5em;\r
257 }\r
258 </style>\r
259 <title>git-commit-tree(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-commit-tree(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-commit-tree -\r
269    Creates a new commit object\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <p><em>git-commit-tree</em> &lt;tree&gt; [-p &lt;parent commit&gt;]* &lt; changelog</p>\r
276 </div>\r
277 <h2>DESCRIPTION</h2>\r
278 <div class="sectionbody">\r
279 <p>Creates a new commit object based on the provided tree object and\r
280 emits the new commit object id on stdout. If no parent is given then\r
281 it is considered to be an initial tree.</p>\r
282 <p>A commit object usually has 1 parent (a commit after a change) or up\r
283 to 16 parents.  More than one parent represents a merge of branches\r
284 that led to them.</p>\r
285 <p>While a tree represents a particular directory state of a working\r
286 directory, a commit represents that state in "time", and explains how\r
287 to get there.</p>\r
288 <p>Normally a commit would identify a new "HEAD" state, and while git\r
289 doesn't care where you save the note about that state, in practice we\r
290 tend to just write the result to the file that is pointed at by\r
291 <tt>.git/HEAD</tt>, so that we can always see what the last committed\r
292 state was.</p>\r
293 </div>\r
294 <h2>OPTIONS</h2>\r
295 <div class="sectionbody">\r
296 <dl>\r
297 <dt>\r
298 &lt;tree&gt;\r
299 </dt>\r
300 <dd>\r
301 <p>\r
302         An existing tree object\r
303 </p>\r
304 </dd>\r
305 <dt>\r
306 -p &lt;parent commit&gt;\r
307 </dt>\r
308 <dd>\r
309 <p>\r
310         Each <em>-p</em> indicates the id of a parent commit object.\r
311 </p>\r
312 </dd>\r
313 </dl>\r
314 </div>\r
315 <h2>Commit Information</h2>\r
316 <div class="sectionbody">\r
317 <p>A commit encapsulates:</p>\r
318 <ul>\r
319 <li>\r
320 <p>\r
321 all parent object ids\r
322 </p>\r
323 </li>\r
324 <li>\r
325 <p>\r
326 author name, email and date\r
327 </p>\r
328 </li>\r
329 <li>\r
330 <p>\r
331 committer name and email and the commit time.\r
332 </p>\r
333 </li>\r
334 </ul>\r
335 <p>If not provided, "git-commit-tree" uses your name, hostname and domain to\r
336 provide author and committer info. This can be overridden by\r
337 either <tt>.git/config</tt> file, or using the following environment variables.</p>\r
338 <div class="literalblock">\r
339 <div class="content">\r
340 <pre><tt>GIT_AUTHOR_NAME\r
341 GIT_AUTHOR_EMAIL\r
342 GIT_AUTHOR_DATE\r
343 GIT_COMMITTER_NAME\r
344 GIT_COMMITTER_EMAIL</tt></pre>\r
345 </div></div>\r
346 <p>(nb "&lt;", "&gt;" and "\n"s are stripped)</p>\r
347 <p>In <tt>.git/config</tt> file, the following items are used for GIT_AUTHOR_NAME and\r
348 GIT_AUTHOR_EMAIL:</p>\r
349 <div class="literalblock">\r
350 <div class="content">\r
351 <pre><tt>[user]\r
352         name = "Your Name"\r
353         email = "your@email.address.xz"</tt></pre>\r
354 </div></div>\r
355 <p>A commit comment is read from stdin (max 999 chars). If a changelog\r
356 entry is not provided via "&lt;" redirection, "git-commit-tree" will just wait\r
357 for one to be entered and terminated with ^D.</p>\r
358 </div>\r
359 <h2>Diagnostics</h2>\r
360 <div class="sectionbody">\r
361 <dl>\r
362 <dt>\r
363 You don't exist. Go away!\r
364 </dt>\r
365 <dd>\r
366 <p>\r
367     The passwd(5) gecos field couldn't be read\r
368 </p>\r
369 </dd>\r
370 <dt>\r
371 Your parents must have hated you!\r
372 </dt>\r
373 <dd>\r
374 <p>\r
375     The password(5) gecos field is longer than a giant static buffer.\r
376 </p>\r
377 </dd>\r
378 <dt>\r
379 Your sysadmin must hate you!\r
380 </dt>\r
381 <dd>\r
382 <p>\r
383     The password(5) name field is longer than a giant static buffer.\r
384 </p>\r
385 </dd>\r
386 </dl>\r
387 </div>\r
388 <h2>See Also</h2>\r
389 <div class="sectionbody">\r
390 <p><a href="git-write-tree.html">git-write-tree(1)</a></p>\r
391 </div>\r
392 <h2>Author</h2>\r
393 <div class="sectionbody">\r
394 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
395 </div>\r
396 <h2>Documentation</h2>\r
397 <div class="sectionbody">\r
398 <p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
399 </div>\r
400 <h2>GIT</h2>\r
401 <div class="sectionbody">\r
402 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
403 </div>\r
404 <div id="footer">\r
405 <div id="footer-text">\r
406 Last updated 06-Jan-2006 17:12:11 PDT\r
407 </div>\r
408 </div>\r
409 </body>\r
410 </html>\r