technical/index-format.html - external/gitster/git-htmldocs - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
 <meta name="generator" content="AsciiDoc 8.6.6" />
 <title>Git index format</title>
 <style type="text/css">
 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */

 /* Default font. */
 body {
  font-family: Georgia,serif;
 }

 /* Title font. */
 h1, h2, h3, h4, h5, h6,
 div.title, caption.title,
 thead, p.table.header,
 #toctitle,
 #author, #revnumber, #revdate, #revremark,
 #footer {
  font-family: Arial,Helvetica,sans-serif;
 }

 body {
  margin: 1em 5% 1em 5%;
 }

 a {
  color: blue;
  text-decoration: underline;
 }
 a:visited {
  color: fuchsia;
 }

 em {
  font-style: italic;
  color: navy;
 }

 strong {
  font-weight: bold;
  color: #083194;
 }

 h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
 }

 h1, h2, h3 {
  border-bottom: 2px solid silver;
 }
 h2 {
  padding-top: 0.5em;
 }
 h3 {
  float: left;
 }
 h3 + * {
  clear: left;
 }
 h5 {
  font-size: 1.0em;
 }

 div.sectionbody {
  margin-left: 0;
 }

 hr {
  border: 1px solid silver;
 }

 p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
 }

 ul, ol, li > p {
  margin-top: 0;
 }
 ul > li { color: #aaa; }
 ul > li > * { color: black; }

 pre {
  padding: 0;
  margin: 0;
 }

 #author {
  color: #527bbd;
  font-weight: bold;
  font-size: 1.1em;
 }
 #email {
 }
 #revnumber, #revdate, #revremark {
 }

 #footer {
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
 }
 #footer-text {
  float: left;
  padding-bottom: 0.5em;
 }
 #footer-badges {
  float: right;
  padding-bottom: 0.5em;
 }

 #preamble {
  margin-top: 1.5em;
  margin-bottom: 1.5em;
 }
 div.imageblock, div.exampleblock, div.verseblock,
 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 div.admonitionblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
 }
 div.admonitionblock {
  margin-top: 2.0em;
  margin-bottom: 2.0em;
  margin-right: 10%;
  color: #606060;
 }

 div.content { /* Block element content. */
  padding: 0;
 }

 /* Block element titles. */
 div.title, caption.title {
  color: #527bbd;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
 }
 div.title + * {
  margin-top: 0;
 }

 td div.title:first-child {
  margin-top: 0.0em;
 }
 div.content div.title:first-child {
  margin-top: 0.0em;
 }
 div.content + div.title {
  margin-top: 0.0em;
 }

 div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid #dddddd;
  border-left: 4px solid #f0f0f0;
  padding: 0.5em;
 }

 div.listingblock > div.content {
  border: 1px solid #dddddd;
  border-left: 5px solid #f0f0f0;
  background: #f8f8f8;
  padding: 0.5em;
 }

 div.quoteblock, div.verseblock {
  padding-left: 1.0em;
  margin-left: 1.0em;
  margin-right: 10%;
  border-left: 5px solid #f0f0f0;
  color: #888;
 }

 div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
 }

 div.verseblock > pre.content {
  font-family: inherit;
  font-size: inherit;
 }
 div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
 }
 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 div.verseblock + div.attribution {
  text-align: left;
 }

 div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
 }
 div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 3px solid #dddddd;
 }

 div.exampleblock > div.content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
 }

 div.imageblock div.content { padding-left: 0; }
 span.image img { border-style: none; }
 a.image:visited { color: white; }

 dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
  color: navy;
 }
 dd > *:first-child {
  margin-top: 0.1em;
 }

 ul, ol {
  list-style-position: outside;
 }
 ol.arabic {
  list-style-type: decimal;
 }
 ol.loweralpha {
  list-style-type: lower-alpha;
 }
 ol.upperalpha {
  list-style-type: upper-alpha;
 }
 ol.lowerroman {
  list-style-type: lower-roman;
 }
 ol.upperroman {
  list-style-type: upper-roman;
 }

 div.compact ul, div.compact ol,
 div.compact p, div.compact p,
 div.compact div, div.compact div {
  margin-top: 0.1em;
  margin-bottom: 0.1em;
 }

 tfoot {
  font-weight: bold;
 }
 td > div.verse {
  white-space: pre;
 }

 div.hdlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 div.hdlist tr {
  padding-bottom: 15px;
 }
 dt.hdlist1.strong, td.hdlist1.strong {
  font-weight: bold;
 }
 td.hdlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
  color: navy;
 }
 td.hdlist2 {
  vertical-align: top;
 }
 div.hdlist.compact tr {
  margin: 0;
  padding-bottom: 0;
 }

 .comment {
  background: yellow;
 }

 .footnote, .footnoteref {
  font-size: 0.8em;
 }

 span.footnote, span.footnoteref {
  vertical-align: super;
 }

 #footnotes {
  margin: 20px 0 20px 0;
  padding: 7px 0 0 0;
 }

 #footnotes div.footnote {
  margin: 0 0 5px 0;
 }

 #footnotes hr {
  border: none;
  border-top: 1px solid silver;
  height: 1px;
  text-align: left;
  margin-left: 0;
  width: 20%;
  min-width: 100px;
 }

 div.colist td {
  padding-right: 0.5em;
  padding-bottom: 0.3em;
  vertical-align: top;
 }
 div.colist td img {
  margin-top: 0.3em;
 }

 @media print {
  #footer-badges { display: none; }
 }

 #toc {
  margin-bottom: 2.5em;
 }

 #toctitle {
  color: #527bbd;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
 }

 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
 }
 div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
 }
 div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
 }
 div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
 }

 span.aqua { color: aqua; }
 span.black { color: black; }
 span.blue { color: blue; }
 span.fuchsia { color: fuchsia; }
 span.gray { color: gray; }
 span.green { color: green; }
 span.lime { color: lime; }
 span.maroon { color: maroon; }
 span.navy { color: navy; }
 span.olive { color: olive; }
 span.purple { color: purple; }
 span.red { color: red; }
 span.silver { color: silver; }
 span.teal { color: teal; }
 span.white { color: white; }
 span.yellow { color: yellow; }

 span.aqua-background { background: aqua; }
 span.black-background { background: black; }
 span.blue-background { background: blue; }
 span.fuchsia-background { background: fuchsia; }
 span.gray-background { background: gray; }
 span.green-background { background: green; }
 span.lime-background { background: lime; }
 span.maroon-background { background: maroon; }
 span.navy-background { background: navy; }
 span.olive-background { background: olive; }
 span.purple-background { background: purple; }
 span.red-background { background: red; }
 span.silver-background { background: silver; }
 span.teal-background { background: teal; }
 span.white-background { background: white; }
 span.yellow-background { background: yellow; }

 span.big { font-size: 2em; }
 span.small { font-size: 0.6em; }

 span.underline { text-decoration: underline; }
 span.overline { text-decoration: overline; }
 span.line-through { text-decoration: line-through; }


 /*
  * xhtml11 specific
  *
  * */

 tt {
  font-family: monospace;
  font-size: inherit;
  color: navy;
 }

 div.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
 }
 div.tableblock > table {
  border: 3px solid #527bbd;
 }
 thead, p.table.header {
  font-weight: bold;
  color: #527bbd;
 }
 p.table {
  margin-top: 0;
 }
 /* Because the table frame attribute is overriden by CSS in most browsers. */
 div.tableblock > table[frame="void"] {
  border-style: none;
 }
 div.tableblock > table[frame="hsides"] {
  border-left-style: none;
  border-right-style: none;
 }
 div.tableblock > table[frame="vsides"] {
  border-top-style: none;
  border-bottom-style: none;
 }


 /*
  * html5 specific
  *
  * */

 .monospaced {
  font-family: monospace;
  font-size: inherit;
  color: navy;
 }

 table.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
 }
 thead, p.tableblock.header {
  font-weight: bold;
  color: #527bbd;
 }
 p.tableblock {
  margin-top: 0;
 }
 table.tableblock {
  border-width: 3px;
  border-spacing: 0px;
  border-style: solid;
  border-color: #527bbd;
  border-collapse: collapse;
 }
 th.tableblock, td.tableblock {
  border-width: 1px;
  padding: 4px;
  border-style: solid;
  border-color: #527bbd;
 }

 table.tableblock.frame-topbot {
  border-left-style: hidden;
  border-right-style: hidden;
 }
 table.tableblock.frame-sides {
  border-top-style: hidden;
  border-bottom-style: hidden;
 }
 table.tableblock.frame-none {
  border-style: hidden;
 }

 th.tableblock.halign-left, td.tableblock.halign-left {
  text-align: left;
 }
 th.tableblock.halign-center, td.tableblock.halign-center {
  text-align: center;
 }
 th.tableblock.halign-right, td.tableblock.halign-right {
  text-align: right;
 }

 th.tableblock.valign-top, td.tableblock.valign-top {
  vertical-align: top;
 }
 th.tableblock.valign-middle, td.tableblock.valign-middle {
  vertical-align: middle;
 }
 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
  vertical-align: bottom;
 }


 /*
  * manpage specific
  *
  * */

 body.manpage h1 {
  padding-top: 0.5em;
  padding-bottom: 0.5em;
  border-top: 2px solid silver;
  border-bottom: 2px solid silver;
 }
 body.manpage h2 {
  border-style: none;
 }
 body.manpage div.sectionbody {
  margin-left: 3em;
 }

 @media print {
  body.manpage div#toc { display: none; }
 }
 </style>
 <script type="text/javascript">
 /*<![CDATA[*/
 var asciidoc = { // Namespace.

 /////////////////////////////////////////////////////////////////////
 // Table Of Contents generator
 /////////////////////////////////////////////////////////////////////

 /* Author: Mihai Bazon, September 2002
  * http://students.infoiasi.ro/~mishoo
  *
  * Table Of Content generator
  * Version: 0.4
  *
  * Feel free to use this script under the terms of the GNU General Public
  * License, as long as you do not remove or alter this notice.
  */

  /* modified by Troy D. Hanson, September 2006. License: GPL */
  /* modified by Stuart Rackham, 2006, 2009. License: GPL */

 // toclevels = 1..4.
 toc: function (toclevels) {

  function getText(el) {
  var text = "";
  for (var i = el.firstChild; i != null; i = i.nextSibling) {
  if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
  text += i.data;
  else if (i.firstChild != null)
  text += getText(i);
  }
  return text;
  }

  function TocEntry(el, text, toclevel) {
  this.element = el;
  this.text = text;
  this.toclevel = toclevel;
  }

  function tocEntries(el, toclevels) {
  var result = new Array;
  var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
  // Function that scans the DOM tree for header elements (the DOM2
  // nodeIterator API would be a better technique but not supported by all
  // browsers).
  var iterate = function (el) {
  for (var i = el.firstChild; i != null; i = i.nextSibling) {
  if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
  var mo = re.exec(i.tagName);
  if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
  result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
  }
  iterate(i);
  }
  }
  }
  iterate(el);
  return result;
  }

  var toc = document.getElementById("toc");
  if (!toc) {
  return;
  }

  // Delete existing TOC entries in case we're reloading the TOC.
  var tocEntriesToRemove = [];
  var i;
  for (i = 0; i < toc.childNodes.length; i++) {
  var entry = toc.childNodes[i];
  if (entry.nodeName == 'div'
  && entry.getAttribute("class")
  && entry.getAttribute("class").match(/^toclevel/))
  tocEntriesToRemove.push(entry);
  }
  for (i = 0; i < tocEntriesToRemove.length; i++) {
  toc.removeChild(tocEntriesToRemove[i]);
  }

  // Rebuild TOC entries.
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
  var entry = entries[i];
  if (entry.element.id == "")
  entry.element.id = "_toc_" + i;
  var a = document.createElement("a");
  a.href = "#" + entry.element.id;
  a.appendChild(document.createTextNode(entry.text));
  var div = document.createElement("div");
  div.appendChild(a);
  div.className = "toclevel" + entry.toclevel;
  toc.appendChild(div);
  }
  if (entries.length == 0)
  toc.parentNode.removeChild(toc);
 },


 /////////////////////////////////////////////////////////////////////
 // Footnotes generator
 /////////////////////////////////////////////////////////////////////

 /* Based on footnote generation code from:
  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
  */

 footnotes: function () {
  // Delete existing footnote entries in case we're reloading the footnodes.
  var i;
  var noteholder = document.getElementById("footnotes");
  if (!noteholder) {
  return;
  }
  var entriesToRemove = [];
  for (i = 0; i < noteholder.childNodes.length; i++) {
  var entry = noteholder.childNodes[i];
  if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")
  entriesToRemove.push(entry);
  }
  for (i = 0; i < entriesToRemove.length; i++) {
  noteholder.removeChild(entriesToRemove[i]);
  }

  // Rebuild footnote entries.
  var cont = document.getElementById("content");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
  if (spans[i].className == "footnote") {
  n++;
  var note = spans[i].getAttribute("data-note");
  if (!note) {
  // Use [\s\S] in place of . so multi-line matches work.
  // Because JavaScript has no s (dotall) regex flag.
  note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
  spans[i].innerHTML =
  "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
  "' title='View footnote' class='footnote'>" + n + "</a>]";
  spans[i].setAttribute("data-note", note);
  }
  noteholder.innerHTML +=
  "<div class='footnote' id='_footnote_" + n + "'>" +
  "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
  n + "</a>. " + note + "</div>";
  var id =spans[i].getAttribute("id");
  if (id != null) refs["#"+id] = n;
  }
  }
  if (n == 0)
  noteholder.parentNode.removeChild(noteholder);
  else {
  // Process footnoterefs.
  for (i=0; i<spans.length; i++) {
  if (spans[i].className == "footnoteref") {
  var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
  href = href.match(/#.*/)[0]; // Because IE return full URL.
  n = refs[href];
  spans[i].innerHTML =
  "[<a href='#_footnote_" + n +
  "' title='View footnote' class='footnote'>" + n + "</a>]";
  }
  }
  }
 },

 install: function(toclevels) {
  var timerId;

  function reinstall() {
  asciidoc.footnotes();
  if (toclevels) {
  asciidoc.toc(toclevels);
  }
  }

  function reinstallAndRemoveTimer() {
  clearInterval(timerId);
  reinstall();
  }

  timerId = setInterval(reinstall, 500);
  if (document.addEventListener)
  document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
  else
  window.onload = reinstallAndRemoveTimer;
 }

 }
 asciidoc.install();
 /*]]>*/
 </script>
 </head>
 <body class="article">
 <div id="header">
 <h1>Git index format</h1>
 </div>
 <div id="content">
 <div class="sect1">
 <h2 id="_the_git_index_file_has_the_following_format">The Git index file has the following format</h2>
 <div class="sectionbody">
 <div class="literalblock">
 <div class="content">
 <pre><tt>All binary numbers are in network byte order. Version 2 is described
 here unless stated otherwise.</tt></pre>
 </div></div>
 <div class="ulist"><ul>
 <li>
 <p>
 A 12-byte header consisting of
 </p>
 <div class="literalblock">
 <div class="content">
 <pre><tt>4-byte signature:
  The signature is { 'D', 'I', 'R', 'C' } (stands for "dircache")</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>4-byte version number:
  The current supported versions are 2, 3 and 4.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit number of index entries.</tt></pre>
 </div></div>
 </li>
 <li>
 <p>
 A number of sorted index entries (see below).
 </p>
 </li>
 <li>
 <p>
 Extensions
 </p>
 <div class="literalblock">
 <div class="content">
 <pre><tt>Extensions are identified by signature. Optional extensions can
 be ignored if Git does not understand them.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>Git currently supports cached tree and resolve undo extensions.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>4-byte extension signature. If the first byte is 'A'..'Z' the
 extension is optional and can be ignored.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit size of the extension</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>Extension data</tt></pre>
 </div></div>
 </li>
 <li>
 <p>
 160-bit SHA-1 over the content of the index file before this
  checksum.
 </p>
 </li>
 </ul></div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_index_entry">Index entry</h2>
 <div class="sectionbody">
 <div class="literalblock">
 <div class="content">
 <pre><tt>Index entries are sorted in ascending order on the name field,
 interpreted as a string of unsigned bytes (i.e. memcmp() order, no
 localization, no special casing of directory separator '/'). Entries
 with the same name are sorted by their stage field.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit ctime seconds, the last time a file's metadata changed
  this is stat(2) data</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit ctime nanosecond fractions
  this is stat(2) data</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit mtime seconds, the last time a file's data changed
  this is stat(2) data</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit mtime nanosecond fractions
  this is stat(2) data</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit dev
  this is stat(2) data</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit ino
  this is stat(2) data</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit mode, split into (high to low bits)</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>4-bit object type
  valid values in binary are 1000 (regular file), 1010 (symbolic link)
  and 1110 (gitlink)</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>3-bit unused</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>9-bit unix permission. Only 0755 and 0644 are valid for regular files.
 Symbolic links and gitlinks have value 0 in this field.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit uid
  this is stat(2) data</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit gid
  this is stat(2) data</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>32-bit file size
  This is the on-disk size from stat(2), truncated to 32-bit.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>160-bit SHA-1 for the represented object</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>A 16-bit 'flags' field split into (high to low bits)</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>1-bit assume-valid flag</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>1-bit extended flag (must be zero in version 2)</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>2-bit stage (during merge)</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>12-bit name length if the length is less than 0xFFF; otherwise 0xFFF
 is stored in this field.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>(Version 3 or later) A 16-bit field, only applicable if the
 "extended flag" above is 1, split into (high to low bits).</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>1-bit reserved for future</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>1-bit skip-worktree flag (used by sparse checkout)</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>1-bit intent-to-add flag (used by "git add -N")</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>13-bit unused, must be zero</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>Entry path name (variable length) relative to top level directory
  (without leading slash). '/' is used as path separator. The special
  path components ".", ".." and ".git" (without quotes) are disallowed.
  Trailing slash is also disallowed.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>The exact encoding is undefined, but the '.' and '/' characters
 are encoded in 7-bit ASCII and the encoding cannot contain a NUL
 byte (iow, this is a UNIX pathname).</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>(Version 4) In version 4, the entry path name is prefix-compressed
  relative to the path name for the previous entry (the very first
  entry is encoded as if the path name for the previous entry is an
  empty string). At the beginning of an entry, an integer N in the
  variable width encoding (the same encoding as the offset is encoded
  for OFS_DELTA pack entries; see pack-format.txt) is stored, followed
  by a NUL-terminated string S. Removing N bytes from the end of the
  path name for the previous entry, and replacing it with the string S
  yields the path name for this entry.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>1-8 nul bytes as necessary to pad the entry to a multiple of eight bytes
 while keeping the name NUL-terminated.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>(Version 4) In version 4, the padding after the pathname does not
 exist.</tt></pre>
 </div></div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_extensions">Extensions</h2>
 <div class="sectionbody">
 <div class="sect2">
 <h3 id="_cached_tree">Cached tree</h3>
 <div class="literalblock">
 <div class="content">
 <pre><tt>Cached tree extension contains pre-computed hashes for trees that can
 be derived from the index. It helps speed up tree object generation
 from index for a new commit.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>When a path is updated in index, the path must be invalidated and
 removed from tree cache.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>The signature for this extension is { 'T', 'R', 'E', 'E' }.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>A series of entries fill the entire extension; each of which
 consists of:</tt></pre>
 </div></div>
 <div class="ulist"><ul>
 <li>
 <p>
 NUL-terminated path component (relative to its parent directory);
 </p>
 </li>
 <li>
 <p>
 ASCII decimal number of entries in the index that is covered by the
  tree this entry represents (entry_count);
 </p>
 </li>
 <li>
 <p>
 A space (ASCII 32);
 </p>
 </li>
 <li>
 <p>
 ASCII decimal number that represents the number of subtrees this
  tree has;
 </p>
 </li>
 <li>
 <p>
 A newline (ASCII 10); and
 </p>
 </li>
 <li>
 <p>
 160-bit object name for the object that would result from writing
  this span of index as a tree.
 </p>
 <div class="literalblock">
 <div class="content">
 <pre><tt>An entry can be in an invalidated state and is represented by having
 a negative number in the entry_count field. In this case, there is no
 object name and the next entry starts immediately after the newline.
 When writing an invalid entry, -1 should always be used as entry_count.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>The entries are written out in the top-down, depth-first order. The
 first entry represents the root level of the repository, followed by the
 first subtree---let's call this A---of the root level (with its name
 relative to the root level), followed by the first subtree of A (with
 its name relative to A), ...</tt></pre>
 </div></div>
 </li>
 </ul></div>
 </div>
 <div class="sect2">
 <h3 id="_resolve_undo">Resolve undo</h3>
 <div class="literalblock">
 <div class="content">
 <pre><tt>A conflict is represented in the index as a set of higher stage entries.
 When a conflict is resolved (e.g. with "git add path"), these higher
 stage entries will be removed and a stage-0 entry with proper resolution
 is added.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>When these higher stage entries are removed, they are saved in the
 resolve undo extension, so that conflicts can be recreated (e.g. with
 "git checkout -m"), in case users want to redo a conflict resolution
 from scratch.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>The signature for this extension is { 'R', 'E', 'U', 'C' }.</tt></pre>
 </div></div>
 <div class="literalblock">
 <div class="content">
 <pre><tt>A series of entries fill the entire extension; each of which
 consists of:</tt></pre>
 </div></div>
 <div class="ulist"><ul>
 <li>
 <p>
 NUL-terminated pathname the entry describes (relative to the root of
  the repository, i.e. full pathname);
 </p>
 </li>
 <li>
 <p>
 Three NUL-terminated ASCII octal numbers, entry mode of entries in
  stage 1 to 3 (a missing stage is represented by "0" in this field);
  and
 </p>
 </li>
 <li>
 <p>
 At most three 160-bit object names of the entry in stages from 1 to 3
  (nothing is written for a missing stage).
 </p>
 </li>
 </ul></div>
 </div>
 </div>
 </div>
 </div>
 <div id="footnotes"><hr /></div>
 <div id="footer">
 <div id="footer-text">
 Last updated 2013-08-20 08:40:27 PDT
 </div>
 </div>
 </body>
 </html>