Autogenerated HTML docs for v2.43.0-334-gd4dbc
[git-htmldocs.git] / git-commit-tree.html
blob39a88be85ccd7b65f44db6dfd8cdbc3e6d3c387d
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-commit-tree(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-commit-tree(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-commit-tree -
743 Create a new commit object
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><em>git commit-tree</em> &lt;tree&gt; [(-p &lt;parent&gt;)&#8230;]
753 <em>git commit-tree</em> [(-p &lt;parent&gt;)&#8230;] [-S[&lt;keyid&gt;]] [(-m &lt;message&gt;)&#8230;]
754 [(-F &lt;file&gt;)&#8230;] &lt;tree&gt;</pre>
755 <div class="attribution">
756 </div></div>
757 </div>
758 </div>
759 <div class="sect1">
760 <h2 id="_description">DESCRIPTION</h2>
761 <div class="sectionbody">
762 <div class="paragraph"><p>This is usually not what an end user wants to run directly. See
763 <a href="git-commit.html">git-commit(1)</a> instead.</p></div>
764 <div class="paragraph"><p>Creates a new commit object based on the provided tree object and
765 emits the new commit object id on stdout. The log message is read
766 from the standard input, unless <code>-m</code> or <code>-F</code> options are given.</p></div>
767 <div class="paragraph"><p>The <code>-m</code> and <code>-F</code> options can be given any number of times, in any
768 order. The commit log message will be composed in the order in which
769 the options are given.</p></div>
770 <div class="paragraph"><p>A commit object may have any number of parents. With exactly one
771 parent, it is an ordinary commit. Having more than one parent makes
772 the commit a merge between several lines of history. Initial (root)
773 commits have no parents.</p></div>
774 <div class="paragraph"><p>While a tree represents a particular directory state of a working
775 directory, a commit represents that state in "time", and explains how
776 to get there.</p></div>
777 <div class="paragraph"><p>Normally a commit would identify a new "HEAD" state, and while Git
778 doesn&#8217;t care where you save the note about that state, in practice we
779 tend to just write the result to the file that is pointed at by
780 <code>.git/HEAD</code>, so that we can always see what the last committed
781 state was.</p></div>
782 </div>
783 </div>
784 <div class="sect1">
785 <h2 id="_options">OPTIONS</h2>
786 <div class="sectionbody">
787 <div class="dlist"><dl>
788 <dt class="hdlist1">
789 &lt;tree&gt;
790 </dt>
791 <dd>
793 An existing tree object.
794 </p>
795 </dd>
796 <dt class="hdlist1">
797 -p &lt;parent&gt;
798 </dt>
799 <dd>
801 Each <code>-p</code> indicates the id of a parent commit object.
802 </p>
803 </dd>
804 <dt class="hdlist1">
805 -m &lt;message&gt;
806 </dt>
807 <dd>
809 A paragraph in the commit log message. This can be given more than
810 once and each &lt;message&gt; becomes its own paragraph.
811 </p>
812 </dd>
813 <dt class="hdlist1">
814 -F &lt;file&gt;
815 </dt>
816 <dd>
818 Read the commit log message from the given file. Use <code>-</code> to read
819 from the standard input. This can be given more than once and the
820 content of each file becomes its own paragraph.
821 </p>
822 </dd>
823 <dt class="hdlist1">
824 -S[&lt;keyid&gt;]
825 </dt>
826 <dt class="hdlist1">
827 --gpg-sign[=&lt;keyid&gt;]
828 </dt>
829 <dt class="hdlist1">
830 --no-gpg-sign
831 </dt>
832 <dd>
834 GPG-sign commits. The <code>keyid</code> argument is optional and
835 defaults to the committer identity; if specified, it must be
836 stuck to the option without a space. <code>--no-gpg-sign</code> is useful to
837 countermand a <code>--gpg-sign</code> option given earlier on the command line.
838 </p>
839 </dd>
840 </dl></div>
841 </div>
842 </div>
843 <div class="sect1">
844 <h2 id="_commit_information">Commit Information</h2>
845 <div class="sectionbody">
846 <div class="paragraph"><p>A commit encapsulates:</p></div>
847 <div class="ulist"><ul>
848 <li>
850 all parent object ids
851 </p>
852 </li>
853 <li>
855 author name, email and date
856 </p>
857 </li>
858 <li>
860 committer name and email and the commit time.
861 </p>
862 </li>
863 </ul></div>
864 <div class="paragraph"><p>A commit comment is read from stdin. If a changelog
865 entry is not provided via "&lt;" redirection, <em>git commit-tree</em> will just wait
866 for one to be entered and terminated with ^D.</p></div>
867 </div>
868 </div>
869 <div class="sect1">
870 <h2 id="_date_formats">DATE FORMATS</h2>
871 <div class="sectionbody">
872 <div class="paragraph"><p>The <code>GIT_AUTHOR_DATE</code> and <code>GIT_COMMITTER_DATE</code> environment variables
873 support the following date formats:</p></div>
874 <div class="dlist"><dl>
875 <dt class="hdlist1">
876 Git internal format
877 </dt>
878 <dd>
880 It is <code>&lt;unix-timestamp&gt; &lt;time-zone-offset&gt;</code>, where
881 <code>&lt;unix-timestamp&gt;</code> is the number of seconds since the UNIX epoch.
882 <code>&lt;time-zone-offset&gt;</code> is a positive or negative offset from UTC.
883 For example CET (which is 1 hour ahead of UTC) is <code>+0100</code>.
884 </p>
885 </dd>
886 <dt class="hdlist1">
887 RFC 2822
888 </dt>
889 <dd>
891 The standard email format as described by RFC 2822, for example
892 <code>Thu, 07 Apr 2005 22:13:13 +0200</code>.
893 </p>
894 </dd>
895 <dt class="hdlist1">
896 ISO 8601
897 </dt>
898 <dd>
900 Time and date specified by the ISO 8601 standard, for example
901 <code>2005-04-07T22:13:13</code>. The parser accepts a space instead of the
902 <code>T</code> character as well. Fractional parts of a second will be ignored,
903 for example <code>2005-04-07T22:13:13.019</code> will be treated as
904 <code>2005-04-07T22:13:13</code>.
905 </p>
906 <div class="admonitionblock">
907 <table><tr>
908 <td class="icon">
909 <div class="title">Note</div>
910 </td>
911 <td class="content">In addition, the date part is accepted in the following formats:
912 <code>YYYY.MM.DD</code>, <code>MM/DD/YYYY</code> and <code>DD.MM.YYYY</code>.</td>
913 </tr></table>
914 </div>
915 </dd>
916 </dl></div>
917 </div>
918 </div>
919 <div class="sect1">
920 <h2 id="_discussion">Discussion</h2>
921 <div class="sectionbody">
922 <div class="paragraph"><p>Git is to some extent character encoding agnostic.</p></div>
923 <div class="ulist"><ul>
924 <li>
926 The contents of the blob objects are uninterpreted sequences
927 of bytes. There is no encoding translation at the core
928 level.
929 </p>
930 </li>
931 <li>
933 Path names are encoded in UTF-8 normalization form C. This
934 applies to tree objects, the index file, ref names, as well as
935 path names in command line arguments, environment variables
936 and config files (<code>.git/config</code> (see <a href="git-config.html">git-config(1)</a>),
937 <a href="gitignore.html">gitignore(5)</a>, <a href="gitattributes.html">gitattributes(5)</a> and
938 <a href="gitmodules.html">gitmodules(5)</a>).
939 </p>
940 <div class="paragraph"><p>Note that Git at the core level treats path names simply as
941 sequences of non-NUL bytes, there are no path name encoding
942 conversions (except on Mac and Windows). Therefore, using
943 non-ASCII path names will mostly work even on platforms and file
944 systems that use legacy extended ASCII encodings. However,
945 repositories created on such systems will not work properly on
946 UTF-8-based systems (e.g. Linux, Mac, Windows) and vice versa.
947 Additionally, many Git-based tools simply assume path names to
948 be UTF-8 and will fail to display other encodings correctly.</p></div>
949 </li>
950 <li>
952 Commit log messages are typically encoded in UTF-8, but other
953 extended ASCII encodings are also supported. This includes
954 ISO-8859-x, CP125x and many others, but <em>not</em> UTF-16/32,
955 EBCDIC and CJK multi-byte encodings (GBK, Shift-JIS, Big5,
956 EUC-x, CP9xx etc.).
957 </p>
958 </li>
959 </ul></div>
960 <div class="paragraph"><p>Although we encourage that the commit log messages are encoded
961 in UTF-8, both the core and Git Porcelain are designed not to
962 force UTF-8 on projects. If all participants of a particular
963 project find it more convenient to use legacy encodings, Git
964 does not forbid it. However, there are a few things to keep in
965 mind.</p></div>
966 <div class="olist arabic"><ol class="arabic">
967 <li>
969 <em>git commit</em> and <em>git commit-tree</em> issue
970 a warning if the commit log message given to it does not look
971 like a valid UTF-8 string, unless you explicitly say your
972 project uses a legacy encoding. The way to say this is to
973 have <code>i18n.commitEncoding</code> in <code>.git/config</code> file, like this:
974 </p>
975 <div class="listingblock">
976 <div class="content">
977 <pre><code>[i18n]
978 commitEncoding = ISO-8859-1</code></pre>
979 </div></div>
980 <div class="paragraph"><p>Commit objects created with the above setting record the value
981 of <code>i18n.commitEncoding</code> in their <code>encoding</code> header. This is to
982 help other people who look at them later. Lack of this header
983 implies that the commit log message is encoded in UTF-8.</p></div>
984 </li>
985 <li>
987 <em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
988 <code>encoding</code> header of a commit object, and try to re-code the
989 log message into UTF-8 unless otherwise specified. You can
990 specify the desired output encoding with
991 <code>i18n.logOutputEncoding</code> in <code>.git/config</code> file, like this:
992 </p>
993 <div class="listingblock">
994 <div class="content">
995 <pre><code>[i18n]
996 logOutputEncoding = ISO-8859-1</code></pre>
997 </div></div>
998 <div class="paragraph"><p>If you do not have this configuration variable, the value of
999 <code>i18n.commitEncoding</code> is used instead.</p></div>
1000 </li>
1001 </ol></div>
1002 <div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log
1003 message when a commit is made to force UTF-8 at the commit
1004 object level, because re-coding to UTF-8 is not necessarily a
1005 reversible operation.</p></div>
1006 </div>
1007 </div>
1008 <div class="sect1">
1009 <h2 id="_files">FILES</h2>
1010 <div class="sectionbody">
1011 <div class="paragraph"><p>/etc/mailname</p></div>
1012 </div>
1013 </div>
1014 <div class="sect1">
1015 <h2 id="_see_also">SEE ALSO</h2>
1016 <div class="sectionbody">
1017 <div class="paragraph"><p><a href="git-write-tree.html">git-write-tree(1)</a>
1018 <a href="git-commit.html">git-commit(1)</a></p></div>
1019 </div>
1020 </div>
1021 <div class="sect1">
1022 <h2 id="_git">GIT</h2>
1023 <div class="sectionbody">
1024 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1025 </div>
1026 </div>
1027 </div>
1028 <div id="footnotes"><hr /></div>
1029 <div id="footer">
1030 <div id="footer-text">
1031 Last updated
1032 2020-04-24 23:01:58 PDT
1033 </div>
1034 </div>
1035 </body>
1036 </html>