Autogenerated HTML docs for v1.7.7-419-g87009
[git/jnareb-git.git] / git-commit-tree.html
blob1f8c3147b128fd7481d859ce3250994dbc40fe61
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" />
6 <meta name="generator" content="AsciiDoc 8.5.2" />
7 <title>git-commit-tree(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 git-commit-tree(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-commit-tree -
578 Create a new commit object
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git commit-tree</em> &lt;tree&gt; [(-p &lt;parent commit&gt;)&#8230;] &lt; changelog</div>
587 <div class="verseblock-attribution">
588 </div></div>
589 </div>
590 <h2 id="_description">DESCRIPTION</h2>
591 <div class="sectionbody">
592 <div class="paragraph"><p>This is usually not what an end user wants to run directly. See
593 <a href="git-commit.html">git-commit(1)</a> instead.</p></div>
594 <div class="paragraph"><p>Creates a new commit object based on the provided tree object and
595 emits the new commit object id on stdout.</p></div>
596 <div class="paragraph"><p>A commit object may have any number of parents. With exactly one
597 parent, it is an ordinary commit. Having more than one parent makes
598 the commit a merge between several lines of history. Initial (root)
599 commits have no parents.</p></div>
600 <div class="paragraph"><p>While a tree represents a particular directory state of a working
601 directory, a commit represents that state in "time", and explains how
602 to get there.</p></div>
603 <div class="paragraph"><p>Normally a commit would identify a new "HEAD" state, and while git
604 doesn&#8217;t care where you save the note about that state, in practice we
605 tend to just write the result to the file that is pointed at by
606 <tt>.git/HEAD</tt>, so that we can always see what the last committed
607 state was.</p></div>
608 </div>
609 <h2 id="_options">OPTIONS</h2>
610 <div class="sectionbody">
611 <div class="dlist"><dl>
612 <dt class="hdlist1">
613 &lt;tree&gt;
614 </dt>
615 <dd>
617 An existing tree object
618 </p>
619 </dd>
620 <dt class="hdlist1">
621 -p &lt;parent commit&gt;
622 </dt>
623 <dd>
625 Each <em>-p</em> indicates the id of a parent commit object.
626 </p>
627 </dd>
628 </dl></div>
629 </div>
630 <h2 id="_commit_information">Commit Information</h2>
631 <div class="sectionbody">
632 <div class="paragraph"><p>A commit encapsulates:</p></div>
633 <div class="ulist"><ul>
634 <li>
636 all parent object ids
637 </p>
638 </li>
639 <li>
641 author name, email and date
642 </p>
643 </li>
644 <li>
646 committer name and email and the commit time.
647 </p>
648 </li>
649 </ul></div>
650 <div class="paragraph"><p>While parent object ids are provided on the command line, author and
651 committer information is taken from the following environment variables,
652 if set:</p></div>
653 <div class="literalblock">
654 <div class="content">
655 <pre><tt>GIT_AUTHOR_NAME
656 GIT_AUTHOR_EMAIL
657 GIT_AUTHOR_DATE
658 GIT_COMMITTER_NAME
659 GIT_COMMITTER_EMAIL
660 GIT_COMMITTER_DATE
661 EMAIL</tt></pre>
662 </div></div>
663 <div class="paragraph"><p>(nb "&lt;", "&gt;" and "\n"s are stripped)</p></div>
664 <div class="paragraph"><p>In case (some of) these environment variables are not set, the information
665 is taken from the configuration items user.name and user.email, or, if not
666 present, system user name and the hostname used for outgoing mail (taken
667 from <tt>/etc/mailname</tt> and falling back to the fully qualified hostname when
668 that file does not exist).</p></div>
669 <div class="paragraph"><p>A commit comment is read from stdin. If a changelog
670 entry is not provided via "&lt;" redirection, <em>git commit-tree</em> will just wait
671 for one to be entered and terminated with ^D.</p></div>
672 </div>
673 <h2 id="_date_formats">DATE FORMATS</h2>
674 <div class="sectionbody">
675 <div class="paragraph"><p>The GIT_AUTHOR_DATE, GIT_COMMITTER_DATE environment variables
676 support the following date formats:</p></div>
677 <div class="dlist"><dl>
678 <dt class="hdlist1">
679 Git internal format
680 </dt>
681 <dd>
683 It is <tt>&lt;unix timestamp&gt; &lt;timezone offset&gt;</tt>, where <tt>&lt;unix
684 timestamp&gt;</tt> is the number of seconds since the UNIX epoch.
685 <tt>&lt;timezone offset&gt;</tt> is a positive or negative offset from UTC.
686 For example CET (which is 2 hours ahead UTC) is <tt>+0200</tt>.
687 </p>
688 </dd>
689 <dt class="hdlist1">
690 RFC 2822
691 </dt>
692 <dd>
694 The standard email format as described by RFC 2822, for example
695 <tt>Thu, 07 Apr 2005 22:13:13 +0200</tt>.
696 </p>
697 </dd>
698 <dt class="hdlist1">
699 ISO 8601
700 </dt>
701 <dd>
703 Time and date specified by the ISO 8601 standard, for example
704 <tt>2005-04-07T22:13:13</tt>. The parser accepts a space instead of the
705 <tt>T</tt> character as well.
706 </p>
707 <div class="admonitionblock">
708 <table><tr>
709 <td class="icon">
710 <div class="title">Note</div>
711 </td>
712 <td class="content">In addition, the date part is accepted in the following formats:
713 <tt>YYYY.MM.DD</tt>, <tt>MM/DD/YYYY</tt> and <tt>DD.MM.YYYY</tt>.</td>
714 </tr></table>
715 </div>
716 </dd>
717 </dl></div>
718 </div>
719 <h2 id="_diagnostics">Diagnostics</h2>
720 <div class="sectionbody">
721 <div class="dlist"><dl>
722 <dt class="hdlist1">
723 You don&#8217;t exist. Go away!
724 </dt>
725 <dd>
727 The passwd(5) gecos field couldn&#8217;t be read
728 </p>
729 </dd>
730 <dt class="hdlist1">
731 Your parents must have hated you!
732 </dt>
733 <dd>
735 The passwd(5) gecos field is longer than a giant static buffer.
736 </p>
737 </dd>
738 <dt class="hdlist1">
739 Your sysadmin must hate you!
740 </dt>
741 <dd>
743 The passwd(5) name field is longer than a giant static buffer.
744 </p>
745 </dd>
746 </dl></div>
747 </div>
748 <h2 id="_discussion">Discussion</h2>
749 <div class="sectionbody">
750 <div class="paragraph"><p>At the core level, git is character encoding agnostic.</p></div>
751 <div class="ulist"><ul>
752 <li>
754 The pathnames recorded in the index and in the tree objects
755 are treated as uninterpreted sequences of non-NUL bytes.
756 What readdir(2) returns are what are recorded and compared
757 with the data git keeps track of, which in turn are expected
758 to be what lstat(2) and creat(2) accepts. There is no such
759 thing as pathname encoding translation.
760 </p>
761 </li>
762 <li>
764 The contents of the blob objects are uninterpreted sequences
765 of bytes. There is no encoding translation at the core
766 level.
767 </p>
768 </li>
769 <li>
771 The commit log messages are uninterpreted sequences of non-NUL
772 bytes.
773 </p>
774 </li>
775 </ul></div>
776 <div class="paragraph"><p>Although we encourage that the commit log messages are encoded
777 in UTF-8, both the core and git Porcelain are designed not to
778 force UTF-8 on projects. If all participants of a particular
779 project find it more convenient to use legacy encodings, git
780 does not forbid it. However, there are a few things to keep in
781 mind.</p></div>
782 <div class="olist arabic"><ol class="arabic">
783 <li>
785 <em>git commit</em> and <em>git commit-tree</em> issues
786 a warning if the commit log message given to it does not look
787 like a valid UTF-8 string, unless you explicitly say your
788 project uses a legacy encoding. The way to say this is to
789 have i18n.commitencoding in <tt>.git/config</tt> file, like this:
790 </p>
791 <div class="listingblock">
792 <div class="content">
793 <pre><tt>[i18n]
794 commitencoding = ISO-8859-1</tt></pre>
795 </div></div>
796 <div class="paragraph"><p>Commit objects created with the above setting record the value
797 of <tt>i18n.commitencoding</tt> in its <tt>encoding</tt> header. This is to
798 help other people who look at them later. Lack of this header
799 implies that the commit log message is encoded in UTF-8.</p></div>
800 </li>
801 <li>
803 <em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
804 <tt>encoding</tt> header of a commit object, and try to re-code the
805 log message into UTF-8 unless otherwise specified. You can
806 specify the desired output encoding with
807 <tt>i18n.logoutputencoding</tt> in <tt>.git/config</tt> file, like this:
808 </p>
809 <div class="listingblock">
810 <div class="content">
811 <pre><tt>[i18n]
812 logoutputencoding = ISO-8859-1</tt></pre>
813 </div></div>
814 <div class="paragraph"><p>If you do not have this configuration variable, the value of
815 <tt>i18n.commitencoding</tt> is used instead.</p></div>
816 </li>
817 </ol></div>
818 <div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log
819 message when a commit is made to force UTF-8 at the commit
820 object level, because re-coding to UTF-8 is not necessarily a
821 reversible operation.</p></div>
822 </div>
823 <h2 id="_files">FILES</h2>
824 <div class="sectionbody">
825 <div class="paragraph"><p>/etc/mailname</p></div>
826 </div>
827 <h2 id="_see_also">SEE ALSO</h2>
828 <div class="sectionbody">
829 <div class="paragraph"><p><a href="git-write-tree.html">git-write-tree(1)</a></p></div>
830 </div>
831 <h2 id="_git">GIT</h2>
832 <div class="sectionbody">
833 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
834 </div>
835 </div>
836 <div id="footnotes"><hr /></div>
837 <div id="footer">
838 <div id="footer-text">
839 Last updated 2011-10-13 22:57:58 PDT
840 </div>
841 </div>
842 </body>
843 </html>