git-pack-objects.html

   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-pack-objects(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  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;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  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;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 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;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 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;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 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;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 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;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 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; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 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;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 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;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 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; }
 392
 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; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 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;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 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.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 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);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 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);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 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);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 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);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 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;
 654   }
 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);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 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);
 682       }
 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;
 689     }
 690   }
 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>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-pack-objects(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-pack-objects -
 743    Create a packed archive of objects
 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 pack-objects</em> [-q | --progress | --all-progress] [--all-progress-implied]
 753         [--no-reuse-delta] [--delta-base-offset] [--non-empty]
 754         [--local] [--incremental] [--window=&lt;n&gt;] [--depth=&lt;n&gt;]
 755         [--revs [--unpacked | --all]] [--keep-pack=&lt;pack-name&gt;]
 756         [--cruft] [--cruft-expiration=&lt;time&gt;]
 757         [--stdout [--filter=&lt;filter-spec&gt;] | &lt;base-name&gt;]
 758         [--shallow] [--keep-true-parents] [--[no-]sparse] &lt; &lt;object-list&gt;</pre>
 759 <div class="attribution">
 760 </div></div>
 761 </div>
 762 </div>
 763 <div class="sect1">
 764 <h2 id="_description">DESCRIPTION</h2>
 765 <div class="sectionbody">
 766 <div class="paragraph"><p>Reads list of objects from the standard input, and writes either one or
 767 more packed archives with the specified base-name to disk, or a packed
 768 archive to the standard output.</p></div>
 769 <div class="paragraph"><p>A packed archive is an efficient way to transfer a set of objects
 770 between two repositories as well as an access efficient archival
 771 format.  In a packed archive, an object is either stored as a
 772 compressed whole or as a difference from some other object.
 773 The latter is often called a delta.</p></div>
 774 <div class="paragraph"><p>The packed archive format (.pack) is designed to be self-contained
 775 so that it can be unpacked without any further information. Therefore,
 776 each object that a delta depends upon must be present within the pack.</p></div>
 777 <div class="paragraph"><p>A pack index file (.idx) is generated for fast, random access to the
 778 objects in the pack. Placing both the index file (.idx) and the packed
 779 archive (.pack) in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
 780 any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
 781 enables Git to read from the pack archive.</p></div>
 782 <div class="paragraph"><p>The <em>git unpack-objects</em> command can read the packed archive and
 783 expand the objects contained in the pack into "one-file
 784 one-object" format; this is typically done by the smart-pull
 785 commands when a pack is created on-the-fly for efficient network
 786 transport by their peers.</p></div>
 787 </div>
 788 </div>
 789 <div class="sect1">
 790 <h2 id="_options">OPTIONS</h2>
 791 <div class="sectionbody">
 792 <div class="dlist"><dl>
 793 <dt class="hdlist1">
 794 base-name
 795 </dt>
 796 <dd>
 797 <p>
 798         Write into pairs of files (.pack and .idx), using
 799         &lt;base-name&gt; to determine the name of the created file.
 800         When this option is used, the two files in a pair are written in
 801         &lt;base-name&gt;-&lt;SHA-1&gt;.{pack,idx} files.  &lt;SHA-1&gt; is a hash
 802         based on the pack content and is written to the standard
 803         output of the command.
 804 </p>
 805 </dd>
 806 <dt class="hdlist1">
 807 --stdout
 808 </dt>
 809 <dd>
 810 <p>
 811         Write the pack contents (what would have been written to
 812         .pack file) out to the standard output.
 813 </p>
 814 </dd>
 815 <dt class="hdlist1">
 816 --revs
 817 </dt>
 818 <dd>
 819 <p>
 820         Read the revision arguments from the standard input, instead of
 821         individual object names.  The revision arguments are processed
 822         the same way as <em>git rev-list</em> with the <code>--objects</code> flag
 823         uses its <code>commit</code> arguments to build the list of objects it
 824         outputs.  The objects on the resulting list are packed.
 825         Besides revisions, <code>--not</code> or <code>--shallow &lt;SHA-1&gt;</code> lines are
 826         also accepted.
 827 </p>
 828 </dd>
 829 <dt class="hdlist1">
 830 --unpacked
 831 </dt>
 832 <dd>
 833 <p>
 834         This implies <code>--revs</code>.  When processing the list of
 835         revision arguments read from the standard input, limit
 836         the objects packed to those that are not already packed.
 837 </p>
 838 </dd>
 839 <dt class="hdlist1">
 840 --all
 841 </dt>
 842 <dd>
 843 <p>
 844         This implies <code>--revs</code>.  In addition to the list of
 845         revision arguments read from the standard input, pretend
 846         as if all refs under <code>refs/</code> are specified to be
 847         included.
 848 </p>
 849 </dd>
 850 <dt class="hdlist1">
 851 --include-tag
 852 </dt>
 853 <dd>
 854 <p>
 855         Include unasked-for annotated tags if the object they
 856         reference was included in the resulting packfile.  This
 857         can be useful to send new tags to native Git clients.
 858 </p>
 859 </dd>
 860 <dt class="hdlist1">
 861 --stdin-packs
 862 </dt>
 863 <dd>
 864 <p>
 865         Read the basenames of packfiles (e.g., <code>pack-1234abcd.pack</code>)
 866         from the standard input, instead of object names or revision
 867         arguments. The resulting pack contains all objects listed in the
 868         included packs (those not beginning with <code>^</code>), excluding any
 869         objects listed in the excluded packs (beginning with <code>^</code>).
 870 </p>
 871 <div class="paragraph"><p>Incompatible with <code>--revs</code>, or options that imply <code>--revs</code> (such as
 872 <code>--all</code>), with the exception of <code>--unpacked</code>, which is compatible.</p></div>
 873 </dd>
 874 <dt class="hdlist1">
 875 --cruft
 876 </dt>
 877 <dd>
 878 <p>
 879         Packs unreachable objects into a separate "cruft" pack, denoted
 880         by the existence of a <code>.mtimes</code> file. Typically used by <code>git
 881         repack --cruft</code>. Callers provide a list of pack names and
 882         indicate which packs will remain in the repository, along with
 883         which packs will be deleted (indicated by the <code>-</code> prefix). The
 884         contents of the cruft pack are all objects not contained in the
 885         surviving packs which have not exceeded the grace period (see
 886         <code>--cruft-expiration</code> below), or which have exceeded the grace
 887         period, but are reachable from an other object which hasn&#8217;t.
 888 </p>
 889 <div class="paragraph"><p>When the input lists a pack containing all reachable objects (and lists
 890 all other packs as pending deletion), the corresponding cruft pack will
 891 contain all unreachable objects (with mtime newer than the
 892 <code>--cruft-expiration</code>) along with any unreachable objects whose mtime is
 893 older than the <code>--cruft-expiration</code>, but are reachable from an
 894 unreachable object whose mtime is newer than the <code>--cruft-expiration</code>).</p></div>
 895 <div class="paragraph"><p>Incompatible with <code>--unpack-unreachable</code>, <code>--keep-unreachable</code>,
 896 <code>--pack-loose-unreachable</code>, <code>--stdin-packs</code>, as well as any other
 897 options which imply <code>--revs</code>.</p></div>
 898 </dd>
 899 <dt class="hdlist1">
 900 --cruft-expiration=&lt;approxidate&gt;
 901 </dt>
 902 <dd>
 903 <p>
 904         If specified, objects are eliminated from the cruft pack if they
 905         have an mtime older than <code>&lt;approxidate&gt;</code>. If unspecified (and
 906         given <code>--cruft</code>), then no objects are eliminated.
 907 </p>
 908 </dd>
 909 <dt class="hdlist1">
 910 --window=&lt;n&gt;
 911 </dt>
 912 <dt class="hdlist1">
 913 --depth=&lt;n&gt;
 914 </dt>
 915 <dd>
 916 <p>
 917         These two options affect how the objects contained in
 918         the pack are stored using delta compression.  The
 919         objects are first internally sorted by type, size and
 920         optionally names and compared against the other objects
 921         within --window to see if using delta compression saves
 922         space.  --depth limits the maximum delta depth; making
 923         it too deep affects the performance on the unpacker
 924         side, because delta data needs to be applied that many
 925         times to get to the necessary object.
 926 </p>
 927 <div class="paragraph"><p>The default value for --window is 10 and --depth is 50. The maximum
 928 depth is 4095.</p></div>
 929 </dd>
 930 <dt class="hdlist1">
 931 --window-memory=&lt;n&gt;
 932 </dt>
 933 <dd>
 934 <p>
 935         This option provides an additional limit on top of <code>--window</code>;
 936         the window size will dynamically scale down so as to not take
 937         up more than <em>&lt;n&gt;</em> bytes in memory.  This is useful in
 938         repositories with a mix of large and small objects to not run
 939         out of memory with a large window, but still be able to take
 940         advantage of the large window for the smaller objects.  The
 941         size can be suffixed with "k", "m", or "g".
 942         <code>--window-memory=0</code> makes memory usage unlimited.  The default
 943         is taken from the <code>pack.windowMemory</code> configuration variable.
 944 </p>
 945 </dd>
 946 <dt class="hdlist1">
 947 --max-pack-size=&lt;n&gt;
 948 </dt>
 949 <dd>
 950 <p>
 951         In unusual scenarios, you may not be able to create files
 952         larger than a certain size on your filesystem, and this option
 953         can be used to tell the command to split the output packfile
 954         into multiple independent packfiles, each not larger than the
 955         given size. The size can be suffixed with
 956         "k", "m", or "g". The minimum size allowed is limited to 1 MiB.
 957         The default is unlimited, unless the config variable
 958         <code>pack.packSizeLimit</code> is set. Note that this option may result in
 959         a larger and slower repository; see the discussion in
 960         <code>pack.packSizeLimit</code>.
 961 </p>
 962 </dd>
 963 <dt class="hdlist1">
 964 --honor-pack-keep
 965 </dt>
 966 <dd>
 967 <p>
 968         This flag causes an object already in a local pack that
 969         has a .keep file to be ignored, even if it would have
 970         otherwise been packed.
 971 </p>
 972 </dd>
 973 <dt class="hdlist1">
 974 --keep-pack=&lt;pack-name&gt;
 975 </dt>
 976 <dd>
 977 <p>
 978         This flag causes an object already in the given pack to be
 979         ignored, even if it would have otherwise been
 980         packed. <code>&lt;pack-name&gt;</code> is the pack file name without
 981         leading directory (e.g. <code>pack-123.pack</code>). The option could be
 982         specified multiple times to keep multiple packs.
 983 </p>
 984 </dd>
 985 <dt class="hdlist1">
 986 --incremental
 987 </dt>
 988 <dd>
 989 <p>
 990         This flag causes an object already in a pack to be ignored
 991         even if it would have otherwise been packed.
 992 </p>
 993 </dd>
 994 <dt class="hdlist1">
 995 --local
 996 </dt>
 997 <dd>
 998 <p>
 999         This flag causes an object that is borrowed from an alternate
1000         object store to be ignored even if it would have otherwise been
1001         packed.
1002 </p>
1003 </dd>
1004 <dt class="hdlist1">
1005 --non-empty
1006 </dt>
1007 <dd>
1008 <p>
1009         Only create a packed archive if it would contain at
1010         least one object.
1011 </p>
1012 </dd>
1013 <dt class="hdlist1">
1014 --progress
1015 </dt>
1016 <dd>
1017 <p>
1018         Progress status is reported on the standard error stream
1019         by default when it is attached to a terminal, unless -q
1020         is specified. This flag forces progress status even if
1021         the standard error stream is not directed to a terminal.
1022 </p>
1023 </dd>
1024 <dt class="hdlist1">
1025 --all-progress
1026 </dt>
1027 <dd>
1028 <p>
1029         When --stdout is specified then progress report is
1030         displayed during the object count and compression phases
1031         but inhibited during the write-out phase. The reason is
1032         that in some cases the output stream is directly linked
1033         to another command which may wish to display progress
1034         status of its own as it processes incoming pack data.
1035         This flag is like --progress except that it forces progress
1036         report for the write-out phase as well even if --stdout is
1037         used.
1038 </p>
1039 </dd>
1040 <dt class="hdlist1">
1041 --all-progress-implied
1042 </dt>
1043 <dd>
1044 <p>
1045         This is used to imply --all-progress whenever progress display
1046         is activated.  Unlike --all-progress this flag doesn&#8217;t actually
1047         force any progress display by itself.
1048 </p>
1049 </dd>
1050 <dt class="hdlist1">
1051 -q
1052 </dt>
1053 <dd>
1054 <p>
1055         This flag makes the command not to report its progress
1056         on the standard error stream.
1057 </p>
1058 </dd>
1059 <dt class="hdlist1">
1060 --no-reuse-delta
1061 </dt>
1062 <dd>
1063 <p>
1064         When creating a packed archive in a repository that
1065         has existing packs, the command reuses existing deltas.
1066         This sometimes results in a slightly suboptimal pack.
1067         This flag tells the command not to reuse existing deltas
1068         but compute them from scratch.
1069 </p>
1070 </dd>
1071 <dt class="hdlist1">
1072 --no-reuse-object
1073 </dt>
1074 <dd>
1075 <p>
1076         This flag tells the command not to reuse existing object data at all,
1077         including non deltified object, forcing recompression of everything.
1078         This implies --no-reuse-delta. Useful only in the obscure case where
1079         wholesale enforcement of a different compression level on the
1080         packed data is desired.
1081 </p>
1082 </dd>
1083 <dt class="hdlist1">
1084 --compression=&lt;n&gt;
1085 </dt>
1086 <dd>
1087 <p>
1088         Specifies compression level for newly-compressed data in the
1089         generated pack.  If not specified,  pack compression level is
1090         determined first by pack.compression,  then by core.compression,
1091         and defaults to -1,  the zlib default,  if neither is set.
1092         Add --no-reuse-object if you want to force a uniform compression
1093         level on all data no matter the source.
1094 </p>
1095 </dd>
1096 <dt class="hdlist1">
1097 --[no-]sparse
1098 </dt>
1099 <dd>
1100 <p>
1101         Toggle the "sparse" algorithm to determine which objects to include in
1102         the pack, when combined with the "--revs" option. This algorithm
1103         only walks trees that appear in paths that introduce new objects.
1104         This can have significant performance benefits when computing
1105         a pack to send a small change. However, it is possible that extra
1106         objects are added to the pack-file if the included commits contain
1107         certain types of direct renames. If this option is not included,
1108         it defaults to the value of <code>pack.useSparse</code>, which is true unless
1109         otherwise specified.
1110 </p>
1111 </dd>
1112 <dt class="hdlist1">
1113 --thin
1114 </dt>
1115 <dd>
1116 <p>
1117         Create a "thin" pack by omitting the common objects between a
1118         sender and a receiver in order to reduce network transfer. This
1119         option only makes sense in conjunction with --stdout.
1120 </p>
1121 <div class="paragraph"><p>Note: A thin pack violates the packed archive format by omitting
1122 required objects and is thus unusable by Git without making it
1123 self-contained. Use <code>git index-pack --fix-thin</code>
1124 (see <a href="git-index-pack.html">git-index-pack(1)</a>) to restore the self-contained property.</p></div>
1125 </dd>
1126 <dt class="hdlist1">
1127 --shallow
1128 </dt>
1129 <dd>
1130 <p>
1131         Optimize a pack that will be provided to a client with a shallow
1132         repository.  This option, combined with --thin, can result in a
1133         smaller pack at the cost of speed.
1134 </p>
1135 </dd>
1136 <dt class="hdlist1">
1137 --delta-base-offset
1138 </dt>
1139 <dd>
1140 <p>
1141         A packed archive can express the base object of a delta as
1142         either a 20-byte object name or as an offset in the
1143         stream, but ancient versions of Git don&#8217;t understand the
1144         latter.  By default, <em>git pack-objects</em> only uses the
1145         former format for better compatibility.  This option
1146         allows the command to use the latter format for
1147         compactness.  Depending on the average delta chain
1148         length, this option typically shrinks the resulting
1149         packfile by 3-5 per-cent.
1150 </p>
1151 <div class="paragraph"><p>Note: Porcelain commands such as <code>git gc</code> (see <a href="git-gc.html">git-gc(1)</a>),
1152 <code>git repack</code> (see <a href="git-repack.html">git-repack(1)</a>) pass this option by default
1153 in modern Git when they put objects in your repository into pack files.
1154 So does <code>git bundle</code> (see <a href="git-bundle.html">git-bundle(1)</a>) when it creates a bundle.</p></div>
1155 </dd>
1156 <dt class="hdlist1">
1157 --threads=&lt;n&gt;
1158 </dt>
1159 <dd>
1160 <p>
1161         Specifies the number of threads to spawn when searching for best
1162         delta matches.  This requires that pack-objects be compiled with
1163         pthreads otherwise this option is ignored with a warning.
1164         This is meant to reduce packing time on multiprocessor machines.
1165         The required amount of memory for the delta search window is
1166         however multiplied by the number of threads.
1167         Specifying 0 will cause Git to auto-detect the number of CPU&#8217;s
1168         and set the number of threads accordingly.
1169 </p>
1170 </dd>
1171 <dt class="hdlist1">
1172 --index-version=&lt;version&gt;[,&lt;offset&gt;]
1173 </dt>
1174 <dd>
1175 <p>
1176         This is intended to be used by the test suite only. It allows
1177         to force the version for the generated pack index, and to force
1178         64-bit index entries on objects located above the given offset.
1179 </p>
1180 </dd>
1181 <dt class="hdlist1">
1182 --keep-true-parents
1183 </dt>
1184 <dd>
1185 <p>
1186         With this option, parents that are hidden by grafts are packed
1187         nevertheless.
1188 </p>
1189 </dd>
1190 <dt class="hdlist1">
1191 --filter=&lt;filter-spec&gt;
1192 </dt>
1193 <dd>
1194 <p>
1195         Requires <code>--stdout</code>.  Omits certain objects (usually blobs) from
1196         the resulting packfile.  See <a href="git-rev-list.html">git-rev-list(1)</a> for valid
1197         <code>&lt;filter-spec&gt;</code> forms.
1198 </p>
1199 </dd>
1200 <dt class="hdlist1">
1201 --no-filter
1202 </dt>
1203 <dd>
1204 <p>
1205         Turns off any previous <code>--filter=</code> argument.
1206 </p>
1207 </dd>
1208 <dt class="hdlist1">
1209 --missing=&lt;missing-action&gt;
1210 </dt>
1211 <dd>
1212 <p>
1213         A debug option to help with future "partial clone" development.
1214         This option specifies how missing objects are handled.
1215 </p>
1216 <div class="paragraph"><p>The form <em>--missing=error</em> requests that pack-objects stop with an error if
1217 a missing object is encountered.  If the repository is a partial clone, an
1218 attempt to fetch missing objects will be made before declaring them missing.
1219 This is the default action.</p></div>
1220 <div class="paragraph"><p>The form <em>--missing=allow-any</em> will allow object traversal to continue
1221 if a missing object is encountered.  No fetch of a missing object will occur.
1222 Missing objects will silently be omitted from the results.</p></div>
1223 <div class="paragraph"><p>The form <em>--missing=allow-promisor</em> is like <em>allow-any</em>, but will only
1224 allow object traversal to continue for EXPECTED promisor missing objects.
1225 No fetch of a missing object will occur.  An unexpected missing object will
1226 raise an error.</p></div>
1227 </dd>
1228 <dt class="hdlist1">
1229 --exclude-promisor-objects
1230 </dt>
1231 <dd>
1232 <p>
1233         Omit objects that are known to be in the promisor remote.  (This
1234         option has the purpose of operating only on locally created objects,
1235         so that when we repack, we still maintain a distinction between
1236         locally created objects [without .promisor] and objects from the
1237         promisor remote [with .promisor].)  This is used with partial clone.
1238 </p>
1239 </dd>
1240 <dt class="hdlist1">
1241 --keep-unreachable
1242 </dt>
1243 <dd>
1244 <p>
1245         Objects unreachable from the refs in packs named with
1246         --unpacked= option are added to the resulting pack, in
1247         addition to the reachable objects that are not in packs marked
1248         with *.keep files. This implies <code>--revs</code>.
1249 </p>
1250 </dd>
1251 <dt class="hdlist1">
1252 --pack-loose-unreachable
1253 </dt>
1254 <dd>
1255 <p>
1256         Pack unreachable loose objects (and their loose counterparts
1257         removed). This implies <code>--revs</code>.
1258 </p>
1259 </dd>
1260 <dt class="hdlist1">
1261 --unpack-unreachable
1262 </dt>
1263 <dd>
1264 <p>
1265         Keep unreachable objects in loose form. This implies <code>--revs</code>.
1266 </p>
1267 </dd>
1268 <dt class="hdlist1">
1269 --delta-islands
1270 </dt>
1271 <dd>
1272 <p>
1273         Restrict delta matches based on "islands". See DELTA ISLANDS
1274         below.
1275 </p>
1276 </dd>
1277 </dl></div>
1278 </div>
1279 </div>
1280 <div class="sect1">
1281 <h2 id="_delta_islands">DELTA ISLANDS</h2>
1282 <div class="sectionbody">
1283 <div class="paragraph"><p>When possible, <code>pack-objects</code> tries to reuse existing on-disk deltas to
1284 avoid having to search for new ones on the fly. This is an important
1285 optimization for serving fetches, because it means the server can avoid
1286 inflating most objects at all and just send the bytes directly from
1287 disk. This optimization can&#8217;t work when an object is stored as a delta
1288 against a base which the receiver does not have (and which we are not
1289 already sending). In that case the server "breaks" the delta and has to
1290 find a new one, which has a high CPU cost. Therefore it&#8217;s important for
1291 performance that the set of objects in on-disk delta relationships match
1292 what a client would fetch.</p></div>
1293 <div class="paragraph"><p>In a normal repository, this tends to work automatically. The objects
1294 are mostly reachable from the branches and tags, and that&#8217;s what clients
1295 fetch. Any deltas we find on the server are likely to be between objects
1296 the client has or will have.</p></div>
1297 <div class="paragraph"><p>But in some repository setups, you may have several related but separate
1298 groups of ref tips, with clients tending to fetch those groups
1299 independently. For example, imagine that you are hosting several "forks"
1300 of a repository in a single shared object store, and letting clients
1301 view them as separate repositories through <code>GIT_NAMESPACE</code> or separate
1302 repos using the alternates mechanism. A naive repack may find that the
1303 optimal delta for an object is against a base that is only found in
1304 another fork. But when a client fetches, they will not have the base
1305 object, and we&#8217;ll have to find a new delta on the fly.</p></div>
1306 <div class="paragraph"><p>A similar situation may exist if you have many refs outside of
1307 <code>refs/heads/</code> and <code>refs/tags/</code> that point to related objects (e.g.,
1308 <code>refs/pull</code> or <code>refs/changes</code> used by some hosting providers). By
1309 default, clients fetch only heads and tags, and deltas against objects
1310 found only in those other groups cannot be sent as-is.</p></div>
1311 <div class="paragraph"><p>Delta islands solve this problem by allowing you to group your refs into
1312 distinct "islands". Pack-objects computes which objects are reachable
1313 from which islands, and refuses to make a delta from an object <code>A</code>
1314 against a base which is not present in all of <code>A</code>'s islands. This
1315 results in slightly larger packs (because we miss some delta
1316 opportunities), but guarantees that a fetch of one island will not have
1317 to recompute deltas on the fly due to crossing island boundaries.</p></div>
1318 <div class="paragraph"><p>When repacking with delta islands the delta window tends to get
1319 clogged with candidates that are forbidden by the config. Repacking
1320 with a big --window helps (and doesn&#8217;t take as long as it otherwise
1321 might because we can reject some object pairs based on islands before
1322 doing any computation on the content).</p></div>
1323 <div class="paragraph"><p>Islands are configured via the <code>pack.island</code> option, which can be
1324 specified multiple times. Each value is a left-anchored regular
1325 expressions matching refnames. For example:</p></div>
1326 <div class="listingblock">
1327 <div class="content">
1328 <pre><code>[pack]
1329 island = refs/heads/
1330 island = refs/tags/</code></pre>
1331 </div></div>
1332 <div class="paragraph"><p>puts heads and tags into an island (whose name is the empty string; see
1333 below for more on naming). Any refs which do not match those regular
1334 expressions (e.g., <code>refs/pull/123</code>) is not in any island. Any object
1335 which is reachable only from <code>refs/pull/</code> (but not heads or tags) is
1336 therefore not a candidate to be used as a base for <code>refs/heads/</code>.</p></div>
1337 <div class="paragraph"><p>Refs are grouped into islands based on their "names", and two regexes
1338 that produce the same name are considered to be in the same
1339 island. The names are computed from the regexes by concatenating any
1340 capture groups from the regex, with a <em>-</em> dash in between. (And if
1341 there are no capture groups, then the name is the empty string, as in
1342 the above example.) This allows you to create arbitrary numbers of
1343 islands. Only up to 14 such capture groups are supported though.</p></div>
1344 <div class="paragraph"><p>For example, imagine you store the refs for each fork in
1345 <code>refs/virtual/ID</code>, where <code>ID</code> is a numeric identifier. You might then
1346 configure:</p></div>
1347 <div class="listingblock">
1348 <div class="content">
1349 <pre><code>[pack]
1350 island = refs/virtual/([0-9]+)/heads/
1351 island = refs/virtual/([0-9]+)/tags/
1352 island = refs/virtual/([0-9]+)/(pull)/</code></pre>
1353 </div></div>
1354 <div class="paragraph"><p>That puts the heads and tags for each fork in their own island (named
1355 "1234" or similar), and the pull refs for each go into their own
1356 "1234-pull".</p></div>
1357 <div class="paragraph"><p>Note that we pick a single island for each regex to go into, using "last
1358 one wins" ordering (which allows repo-specific config to take precedence
1359 over user-wide config, and so forth).</p></div>
1360 </div>
1361 </div>
1362 <div class="sect1">
1363 <h2 id="_configuration">CONFIGURATION</h2>
1364 <div class="sectionbody">
1365 <div class="paragraph"><p>Various configuration variables affect packing, see
1366 <a href="git-config.html">git-config(1)</a> (search for "pack" and "delta").</p></div>
1367 <div class="paragraph"><p>Notably, delta compression is not used on objects larger than the
1368 <code>core.bigFileThreshold</code> configuration variable and on files with the
1369 attribute <code>delta</code> set to false.</p></div>
1370 </div>
1371 </div>
1372 <div class="sect1">
1373 <h2 id="_see_also">SEE ALSO</h2>
1374 <div class="sectionbody">
1375 <div class="paragraph"><p><a href="git-rev-list.html">git-rev-list(1)</a>
1376 <a href="git-repack.html">git-repack(1)</a>
1377 <a href="git-prune-packed.html">git-prune-packed(1)</a></p></div>
1378 </div>
1379 </div>
1380 <div class="sect1">
1381 <h2 id="_git">GIT</h2>
1382 <div class="sectionbody">
1383 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1384 </div>
1385 </div>
1386 </div>
1387 <div id="footnotes"><hr /></div>
1388 <div id="footer">
1389 <div id="footer-text">
1390 Last updated
1391  2023-09-07 15:10:34 PDT
1392 </div>
1393 </div>
1394 </body>
1395 </html>