git-commit-tree.html

   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.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, 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
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#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 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.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 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.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 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#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
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.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
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-commit-tree(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-commit-tree(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-commit-tree -
 317    Create a new commit object
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="para"><p><em>git commit-tree</em> &lt;tree&gt; [-p &lt;parent commit&gt;]* &lt; changelog</p></div>
 324 </div>
 325 <h2 id="_description">DESCRIPTION</h2>
 326 <div class="sectionbody">
 327 <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
 330 emits 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
 332 parent, it is an ordinary commit. Having more than one parent makes
 333 the commit a merge between several lines of history. Initial (root)
 334 commits have no parents.</p></div>
 335 <div class="para"><p>While a tree represents a particular directory state of a working
 336 directory, a commit represents that state in "time", and explains how
 337 to get there.</p></div>
 338 <div class="para"><p>Normally a commit would identify a new "HEAD" state, and while git
 339 doesn't care where you save the note about that state, in practice we
 340 tend 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
 342 state was.</p></div>
 343 </div>
 344 <h2 id="_options">OPTIONS</h2>
 345 <div class="sectionbody">
 346 <div class="vlist"><dl>
 347 <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>
 363 </dl></div>
 364 </div>
 365 <h2 id="_commit_information">Commit Information</h2>
 366 <div class="sectionbody">
 367 <div class="para"><p>A commit encapsulates:</p></div>
 368 <div class="ilist"><ul>
 369 <li>
 370 <p>
 371 all parent object ids
 372 </p>
 373 </li>
 374 <li>
 375 <p>
 376 author name, email and date
 377 </p>
 378 </li>
 379 <li>
 380 <p>
 381 committer name and email and the commit time.
 382 </p>
 383 </li>
 384 </ul></div>
 385 <div class="para"><p>While parent object ids are provided on the command line, author and
 386 committer information is taken from the following environment variables,
 387 if set:</p></div>
 388 <div class="literalblock">
 389 <div class="content">
 390 <pre><tt>GIT_AUTHOR_NAME
 391 GIT_AUTHOR_EMAIL
 392 GIT_AUTHOR_DATE
 393 GIT_COMMITTER_NAME
 394 GIT_COMMITTER_EMAIL
 395 GIT_COMMITTER_DATE
 396 EMAIL</tt></pre>
 397 </div></div>
 398 <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
 400 is taken from the configuration items user.name and user.email, or, if not
 401 present, system user name and fully qualified hostname.</p></div>
 402 <div class="para"><p>A commit comment is read from stdin. If a changelog
 403 entry is not provided via "&lt;" redirection, <em>git commit-tree</em> will just wait
 404 for one to be entered and terminated with ^D.</p></div>
 405 </div>
 406 <h2 id="_date_formats">DATE FORMATS</h2>
 407 <div class="sectionbody">
 408 <div class="para"><p>The GIT_AUTHOR_DATE, GIT_COMMITTER_DATE environment variables
 409 support the following date formats:</p></div>
 410 <div class="vlist"><dl>
 411 <dt>
 412 Git internal format
 413 </dt>
 414 <dd>
 415 <p>
 416         It is <tt>&lt;unix timestamp&gt; &lt;timezone offset&gt;</tt>, where <tt>&lt;unix
 417         timestamp&gt;</tt> is the number of seconds since the UNIX epoch.
 418         <tt>&lt;timezone offset&gt;</tt> is a positive or negative offset from UTC.
 419         For example CET (which is 2 hours ahead UTC) is <tt>+0200</tt>.
 420 </p>
 421 </dd>
 422 <dt>
 423 RFC 2822
 424 </dt>
 425 <dd>
 426 <p>
 427         The standard email format as described by RFC 2822, for example
 428         <tt>Thu, 07 Apr 2005 22:13:13 +0200</tt>.
 429 </p>
 430 </dd>
 431 <dt>
 432 ISO 8601
 433 </dt>
 434 <dd>
 435 <p>
 436         Time and date specified by the ISO 8601 standard, for example
 437         <tt>2005-04-07T22:13:13</tt>. The parser accepts a space instead of the
 438         <tt>T</tt> character as well.
 439 </p>
 440 <div class="admonitionblock">
 441 <table><tr>
 442 <td class="icon">
 443 <div class="title">Note</div>
 444 </td>
 445 <td class="content">In addition, the date part is accepted in the following formats:
 446 <tt>YYYY.MM.DD</tt>, <tt>MM/DD/YYYY</tt> and <tt>DD.MM.YYYY</tt>.</td>
 447 </tr></table>
 448 </div>
 449 </dd>
 450 </dl></div>
 451 </div>
 452 <h2 id="_diagnostics">Diagnostics</h2>
 453 <div class="sectionbody">
 454 <div class="vlist"><dl>
 455 <dt>
 456 You don't exist. Go away!
 457 </dt>
 458 <dd>
 459 <p>
 460     The passwd(5) gecos field couldn't be read
 461 </p>
 462 </dd>
 463 <dt>
 464 Your parents must have hated you!
 465 </dt>
 466 <dd>
 467 <p>
 468     The passwd(5) gecos field is longer than a giant static buffer.
 469 </p>
 470 </dd>
 471 <dt>
 472 Your sysadmin must hate you!
 473 </dt>
 474 <dd>
 475 <p>
 476     The passwd(5) name field is longer than a giant static buffer.
 477 </p>
 478 </dd>
 479 </dl></div>
 480 </div>
 481 <h2 id="_discussion">Discussion</h2>
 482 <div class="sectionbody">
 483 <div class="para"><p>At the core level, git is character encoding agnostic.</p></div>
 484 <div class="ilist"><ul>
 485 <li>
 486 <p>
 487 The pathnames recorded in the index and in the tree objects
 488    are treated as uninterpreted sequences of non-NUL bytes.
 489    What readdir(2) returns are what are recorded and compared
 490    with the data git keeps track of, which in turn are expected
 491    to be what lstat(2) and creat(2) accepts.  There is no such
 492    thing as pathname encoding translation.
 493 </p>
 494 </li>
 495 <li>
 496 <p>
 497 The contents of the blob objects are uninterpreted sequences
 498    of bytes.  There is no encoding translation at the core
 499    level.
 500 </p>
 501 </li>
 502 <li>
 503 <p>
 504 The commit log messages are uninterpreted sequences of non-NUL
 505    bytes.
 506 </p>
 507 </li>
 508 </ul></div>
 509 <div class="para"><p>Although we encourage that the commit log messages are encoded
 510 in UTF-8, both the core and git Porcelain are designed not to
 511 force UTF-8 on projects.  If all participants of a particular
 512 project find it more convenient to use legacy encodings, git
 513 does not forbid it.  However, there are a few things to keep in
 514 mind.</p></div>
 515 <div class="olist"><ol>
 516 <li>
 517 <p>
 518 <em>git commit</em> and <em>git commit-tree</em> issues
 519   a warning if the commit log message given to it does not look
 520   like a valid UTF-8 string, unless you explicitly say your
 521   project uses a legacy encoding.  The way to say this is to
 522   have i18n.commitencoding in <tt>.git/config</tt> file, like this:
 523 </p>
 524 <div class="listingblock">
 525 <div class="content">
 526 <pre><tt>[i18n]
 527         commitencoding = ISO-8859-1</tt></pre>
 528 </div></div>
 529 <div class="para"><p>Commit objects created with the above setting record the value
 530 of <tt>i18n.commitencoding</tt> in its <tt>encoding</tt> header.  This is to
 531 help other people who look at them later.  Lack of this header
 532 implies that the commit log message is encoded in UTF-8.</p></div>
 533 </li>
 534 <li>
 535 <p>
 536 <em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
 537   <tt>encoding</tt> header of a commit object, and try to re-code the
 538   log message into UTF-8 unless otherwise specified.  You can
 539   specify the desired output encoding with
 540   <tt>i18n.logoutputencoding</tt> in <tt>.git/config</tt> file, like this:
 541 </p>
 542 <div class="listingblock">
 543 <div class="content">
 544 <pre><tt>[i18n]
 545         logoutputencoding = ISO-8859-1</tt></pre>
 546 </div></div>
 547 <div class="para"><p>If you do not have this configuration variable, the value of
 548 <tt>i18n.commitencoding</tt> is used instead.</p></div>
 549 </li>
 550 </ol></div>
 551 <div class="para"><p>Note that we deliberately chose not to re-code the commit log
 552 message when a commit is made to force UTF-8 at the commit
 553 object level, because re-coding to UTF-8 is not necessarily a
 554 reversible operation.</p></div>
 555 </div>
 556 <h2 id="_see_also">SEE ALSO</h2>
 557 <div class="sectionbody">
 558 <div class="para"><p><a href="git-write-tree.html">git-write-tree(1)</a></p></div>
 559 </div>
 560 <h2 id="_author">Author</h2>
 561 <div class="sectionbody">
 562 <div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
 563 </div>
 564 <h2 id="_documentation">Documentation</h2>
 565 <div class="sectionbody">
 566 <div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
 567 </div>
 568 <h2 id="_git">GIT</h2>
 569 <div class="sectionbody">
 570 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 571 </div>
 572 <div id="footer">
 573 <div id="footer-text">
 574 Last updated 2010-01-21 17:44:23 UTC
 575 </div>
 576 </div>
 577 </body>
 578 </html>