git-gc.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-gc(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-gc(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-gc -
 743    Cleanup unnecessary files and optimize the local repository
 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 gc</em> [--aggressive] [--auto] [--quiet] [--prune=&lt;date&gt; | --no-prune] [--force] [--keep-largest-pack]</pre>
 753 <div class="attribution">
 754 </div></div>
 755 </div>
 756 </div>
 757 <div class="sect1">
 758 <h2 id="_description">DESCRIPTION</h2>
 759 <div class="sectionbody">
 760 <div class="paragraph"><p>Runs a number of housekeeping tasks within the current repository,
 761 such as compressing file revisions (to reduce disk space and increase
 762 performance), removing unreachable objects which may have been
 763 created from prior invocations of <em>git add</em>, packing refs, pruning
 764 reflog, rerere metadata or stale working trees. May also update ancillary
 765 indexes such as the commit-graph.</p></div>
 766 <div class="paragraph"><p>When common porcelain operations that create objects are run, they
 767 will check whether the repository has grown substantially since the
 768 last maintenance, and if so run <code>git gc</code> automatically. See <code>gc.auto</code>
 769 below for how to disable this behavior.</p></div>
 770 <div class="paragraph"><p>Running <code>git gc</code> manually should only be needed when adding objects to
 771 a repository without regularly running such porcelain commands, to do
 772 a one-off repository optimization, or e.g. to clean up a suboptimal
 773 mass-import. See the "PACKFILE OPTIMIZATION" section in
 774 <a href="git-fast-import.html">git-fast-import(1)</a> for more details on the import case.</p></div>
 775 </div>
 776 </div>
 777 <div class="sect1">
 778 <h2 id="_options">OPTIONS</h2>
 779 <div class="sectionbody">
 780 <div class="dlist"><dl>
 781 <dt class="hdlist1">
 782 --aggressive
 783 </dt>
 784 <dd>
 785 <p>
 786         Usually <em>git gc</em> runs very quickly while providing good disk
 787         space utilization and performance.  This option will cause
 788         <em>git gc</em> to more aggressively optimize the repository at the expense
 789         of taking much more time.  The effects of this optimization are
 790         mostly persistent. See the "AGGRESSIVE" section below for details.
 791 </p>
 792 </dd>
 793 <dt class="hdlist1">
 794 --auto
 795 </dt>
 796 <dd>
 797 <p>
 798         With this option, <em>git gc</em> checks whether any housekeeping is
 799         required; if not, it exits without performing any work.
 800 </p>
 801 <div class="paragraph"><p>See the <code>gc.auto</code> option in the "CONFIGURATION" section below for how
 802 this heuristic works.</p></div>
 803 <div class="paragraph"><p>Once housekeeping is triggered by exceeding the limits of
 804 configuration options such as <code>gc.auto</code> and <code>gc.autoPackLimit</code>, all
 805 other housekeeping tasks (e.g. rerere, working trees, reflog&#8230;) will
 806 be performed as well.</p></div>
 807 </dd>
 808 <dt class="hdlist1">
 809 --[no-]cruft
 810 </dt>
 811 <dd>
 812 <p>
 813         When expiring unreachable objects, pack them separately into a
 814         cruft pack instead of storing them as loose objects. <code>--cruft</code>
 815         is on by default.
 816 </p>
 817 </dd>
 818 <dt class="hdlist1">
 819 --max-cruft-size=&lt;n&gt;
 820 </dt>
 821 <dd>
 822 <p>
 823         When packing unreachable objects into a cruft pack, limit the
 824         size of new cruft packs to be at most <code>&lt;n&gt;</code> bytes. Overrides any
 825         value specified via the <code>gc.maxCruftSize</code> configuration. See
 826         the <code>--max-cruft-size</code> option of <a href="git-repack.html">git-repack(1)</a> for
 827         more.
 828 </p>
 829 </dd>
 830 <dt class="hdlist1">
 831 --prune=&lt;date&gt;
 832 </dt>
 833 <dd>
 834 <p>
 835         Prune loose objects older than date (default is 2 weeks ago,
 836         overridable by the config variable <code>gc.pruneExpire</code>).
 837         --prune=now prunes loose objects regardless of their age and
 838         increases the risk of corruption if another process is writing to
 839         the repository concurrently; see "NOTES" below. --prune is on by
 840         default.
 841 </p>
 842 </dd>
 843 <dt class="hdlist1">
 844 --no-prune
 845 </dt>
 846 <dd>
 847 <p>
 848         Do not prune any loose objects.
 849 </p>
 850 </dd>
 851 <dt class="hdlist1">
 852 --quiet
 853 </dt>
 854 <dd>
 855 <p>
 856         Suppress all progress reports.
 857 </p>
 858 </dd>
 859 <dt class="hdlist1">
 860 --force
 861 </dt>
 862 <dd>
 863 <p>
 864         Force <code>git gc</code> to run even if there may be another <code>git gc</code>
 865         instance running on this repository.
 866 </p>
 867 </dd>
 868 <dt class="hdlist1">
 869 --keep-largest-pack
 870 </dt>
 871 <dd>
 872 <p>
 873         All packs except the largest non-cruft pack, any packs marked
 874         with a <code>.keep</code> file, and any cruft pack(s) are consolidated into
 875         a single pack. When this option is used, <code>gc.bigPackThreshold</code>
 876         is ignored.
 877 </p>
 878 </dd>
 879 </dl></div>
 880 </div>
 881 </div>
 882 <div class="sect1">
 883 <h2 id="_aggressive">AGGRESSIVE</h2>
 884 <div class="sectionbody">
 885 <div class="paragraph"><p>When the <code>--aggressive</code> option is supplied, <a href="git-repack.html">git-repack(1)</a> will
 886 be invoked with the <code>-f</code> flag, which in turn will pass
 887 <code>--no-reuse-delta</code> to <a href="git-pack-objects.html">git-pack-objects(1)</a>. This will throw
 888 away any existing deltas and re-compute them, at the expense of
 889 spending much more time on the repacking.</p></div>
 890 <div class="paragraph"><p>The effects of this are mostly persistent, e.g. when packs and loose
 891 objects are coalesced into one another pack the existing deltas in
 892 that pack might get re-used, but there are also various cases where we
 893 might pick a sub-optimal delta from a newer pack instead.</p></div>
 894 <div class="paragraph"><p>Furthermore, supplying <code>--aggressive</code> will tweak the <code>--depth</code> and
 895 <code>--window</code> options passed to <a href="git-repack.html">git-repack(1)</a>. See the
 896 <code>gc.aggressiveDepth</code> and <code>gc.aggressiveWindow</code> settings below. By
 897 using a larger window size we&#8217;re more likely to find more optimal
 898 deltas.</p></div>
 899 <div class="paragraph"><p>It&#8217;s probably not worth it to use this option on a given repository
 900 without running tailored performance benchmarks on it. It takes a lot
 901 more time, and the resulting space/delta optimization may or may not
 902 be worth it. Not using this at all is the right trade-off for most
 903 users and their repositories.</p></div>
 904 </div>
 905 </div>
 906 <div class="sect1">
 907 <h2 id="_configuration">CONFIGURATION</h2>
 908 <div class="sectionbody">
 909 <div class="paragraph"><p>Everything below this line in this section is selectively included
 910 from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
 911 as what&#8217;s found there:</p></div>
 912 <div class="dlist"><dl>
 913 <dt class="hdlist1">
 914 gc.aggressiveDepth
 915 </dt>
 916 <dd>
 917 <p>
 918         The depth parameter used in the delta compression
 919         algorithm used by <em>git gc --aggressive</em>.  This defaults
 920         to 50, which is the default for the <code>--depth</code> option when
 921         <code>--aggressive</code> isn&#8217;t in use.
 922 </p>
 923 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
 924 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
 925 </dd>
 926 <dt class="hdlist1">
 927 gc.aggressiveWindow
 928 </dt>
 929 <dd>
 930 <p>
 931         The window size parameter used in the delta compression
 932         algorithm used by <em>git gc --aggressive</em>.  This defaults
 933         to 250, which is a much more aggressive window size than
 934         the default <code>--window</code> of 10.
 935 </p>
 936 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
 937 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
 938 </dd>
 939 <dt class="hdlist1">
 940 gc.auto
 941 </dt>
 942 <dd>
 943 <p>
 944         When there are approximately more than this many loose
 945         objects in the repository, <code>git gc --auto</code> will pack them.
 946         Some Porcelain commands use this command to perform a
 947         light-weight garbage collection from time to time.  The
 948         default value is 6700.
 949 </p>
 950 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
 951 number of loose objects, but also any other heuristic <code>git gc --auto</code> will
 952 otherwise use to determine if there&#8217;s work to do, such as
 953 <code>gc.autoPackLimit</code>.</p></div>
 954 </dd>
 955 <dt class="hdlist1">
 956 gc.autoPackLimit
 957 </dt>
 958 <dd>
 959 <p>
 960         When there are more than this many packs that are not
 961         marked with <code>*.keep</code> file in the repository, <code>git gc
 962         --auto</code> consolidates them into one larger pack.  The
 963         default value is 50.  Setting this to 0 disables it.
 964         Setting <code>gc.auto</code> to 0 will also disable this.
 965 </p>
 966 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
 967 use, it&#8217;ll affect how the auto pack limit works.</p></div>
 968 </dd>
 969 <dt class="hdlist1">
 970 gc.autoDetach
 971 </dt>
 972 <dd>
 973 <p>
 974         Make <code>git gc --auto</code> return immediately and run in the background
 975         if the system supports it. Default is true.
 976 </p>
 977 </dd>
 978 <dt class="hdlist1">
 979 gc.bigPackThreshold
 980 </dt>
 981 <dd>
 982 <p>
 983         If non-zero, all non-cruft packs larger than this limit are kept
 984         when <code>git gc</code> is run. This is very similar to
 985         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
 986         the threshold are kept, not just the largest pack. Defaults to
 987         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
 988 </p>
 989 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
 990 this configuration variable is ignored, all packs except the base pack
 991 will be repacked. After this the number of packs should go below
 992 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
 993 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
 994 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
 995 will also be excluded (this is the equivalent of running <code>git gc</code> with
 996 <code>--keep-largest-pack</code>).</p></div>
 997 </dd>
 998 <dt class="hdlist1">
 999 gc.writeCommitGraph
1000 </dt>
1001 <dd>
1002 <p>
1003         If true, then gc will rewrite the commit-graph file when
1004         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
1005         the commit-graph will be updated if housekeeping is
1006         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
1007         for details.
1008 </p>
1009 </dd>
1010 <dt class="hdlist1">
1011 gc.logExpiry
1012 </dt>
1013 <dd>
1014 <p>
1015         If the file gc.log exists, then <code>git gc --auto</code> will print
1016         its content and exit with status zero instead of running
1017         unless that file is more than <em>gc.logExpiry</em> old.  Default is
1018         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
1019         value.
1020 </p>
1021 </dd>
1022 <dt class="hdlist1">
1023 gc.packRefs
1024 </dt>
1025 <dd>
1026 <p>
1027         Running <code>git pack-refs</code> in a repository renders it
1028         unclonable by Git versions prior to 1.5.1.2 over dumb
1029         transports such as HTTP.  This variable determines whether
1030         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
1031         to enable it within all non-bare repos or it can be set to a
1032         boolean value.  The default is <code>true</code>.
1033 </p>
1034 </dd>
1035 <dt class="hdlist1">
1036 gc.cruftPacks
1037 </dt>
1038 <dd>
1039 <p>
1040         Store unreachable objects in a cruft pack (see
1041         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
1042         is <code>true</code>.
1043 </p>
1044 </dd>
1045 <dt class="hdlist1">
1046 gc.maxCruftSize
1047 </dt>
1048 <dd>
1049 <p>
1050         Limit the size of new cruft packs when repacking. When
1051         specified in addition to <code>--max-cruft-size</code>, the command line
1052         option takes priority. See the <code>--max-cruft-size</code> option of
1053         <a href="git-repack.html">git-repack(1)</a>.
1054 </p>
1055 </dd>
1056 <dt class="hdlist1">
1057 gc.pruneExpire
1058 </dt>
1059 <dd>
1060 <p>
1061         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
1062         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
1063         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
1064         grace period with this config variable.  The value "now" may be
1065         used to disable this grace period and always prune unreachable
1066         objects immediately, or "never" may be used to suppress pruning.
1067         This feature helps prevent corruption when <em>git gc</em> runs
1068         concurrently with another process writing to the repository; see
1069         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
1070 </p>
1071 </dd>
1072 <dt class="hdlist1">
1073 gc.worktreePruneExpire
1074 </dt>
1075 <dd>
1076 <p>
1077         When <em>git gc</em> is run, it calls
1078         <em>git worktree prune --expire 3.months.ago</em>.
1079         This config variable can be used to set a different grace
1080         period. The value "now" may be used to disable the grace
1081         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
1082         may be used to suppress pruning.
1083 </p>
1084 </dd>
1085 <dt class="hdlist1">
1086 gc.reflogExpire
1087 </dt>
1088 <dt class="hdlist1">
1089 gc.&lt;pattern&gt;.reflogExpire
1090 </dt>
1091 <dd>
1092 <p>
1093         <em>git reflog expire</em> removes reflog entries older than
1094         this time; defaults to 90 days. The value "now" expires all
1095         entries immediately, and "never" suppresses expiration
1096         altogether. With "&lt;pattern&gt;" (e.g.
1097         "refs/stash") in the middle the setting applies only to
1098         the refs that match the &lt;pattern&gt;.
1099 </p>
1100 </dd>
1101 <dt class="hdlist1">
1102 gc.reflogExpireUnreachable
1103 </dt>
1104 <dt class="hdlist1">
1105 gc.&lt;pattern&gt;.reflogExpireUnreachable
1106 </dt>
1107 <dd>
1108 <p>
1109         <em>git reflog expire</em> removes reflog entries older than
1110         this time and are not reachable from the current tip;
1111         defaults to 30 days. The value "now" expires all entries
1112         immediately, and "never" suppresses expiration altogether.
1113         With "&lt;pattern&gt;" (e.g. "refs/stash")
1114         in the middle, the setting applies only to the refs that
1115         match the &lt;pattern&gt;.
1116 </p>
1117 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
1118 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
1119 or rebase occurring.  Since these changes are not part of the current
1120 project most users will want to expire them sooner, which is why the
1121 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
1122 </dd>
1123 <dt class="hdlist1">
1124 gc.recentObjectsHook
1125 </dt>
1126 <dd>
1127 <p>
1128         When considering whether or not to remove an object (either when
1129         generating a cruft pack or storing unreachable objects as
1130         loose), use the shell to execute the specified command(s).
1131         Interpret their output as object IDs which Git will consider as
1132         "recent", regardless of their age. By treating their mtimes as
1133         "now", any objects (and their descendants) mentioned in the
1134         output will be kept regardless of their true age.
1135 </p>
1136 <div class="paragraph"><p>Output must contain exactly one hex object ID per line, and nothing
1137 else. Objects which cannot be found in the repository are ignored.
1138 Multiple hooks are supported, but all must exit successfully, else the
1139 operation (either generating a cruft pack or unpacking unreachable
1140 objects) will be halted.</p></div>
1141 </dd>
1142 <dt class="hdlist1">
1143 gc.repackFilter
1144 </dt>
1145 <dd>
1146 <p>
1147         When repacking, use the specified filter to move certain
1148         objects into a separate packfile.  See the
1149         <code>--filter=&lt;filter-spec&gt;</code> option of <a href="git-repack.html">git-repack(1)</a>.
1150 </p>
1151 </dd>
1152 <dt class="hdlist1">
1153 gc.repackFilterTo
1154 </dt>
1155 <dd>
1156 <p>
1157         When repacking and using a filter, see <code>gc.repackFilter</code>, the
1158         specified location will be used to create the packfile
1159         containing the filtered out objects. <strong>WARNING:</strong> The
1160         specified location should be accessible, using for example the
1161         Git alternates mechanism, otherwise the repo could be
1162         considered corrupt by Git as it migh not be able to access the
1163         objects in that packfile. See the <code>--filter-to=&lt;dir&gt;</code> option
1164         of <a href="git-repack.html">git-repack(1)</a> and the <code>objects/info/alternates</code>
1165         section of <a href="gitrepository-layout.html">gitrepository-layout(5)</a>.
1166 </p>
1167 </dd>
1168 <dt class="hdlist1">
1169 gc.rerereResolved
1170 </dt>
1171 <dd>
1172 <p>
1173         Records of conflicted merge you resolved earlier are
1174         kept for this many days when <em>git rerere gc</em> is run.
1175         You can also use more human-readable "1.month.ago", etc.
1176         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
1177 </p>
1178 </dd>
1179 <dt class="hdlist1">
1180 gc.rerereUnresolved
1181 </dt>
1182 <dd>
1183 <p>
1184         Records of conflicted merge you have not resolved are
1185         kept for this many days when <em>git rerere gc</em> is run.
1186         You can also use more human-readable "1.month.ago", etc.
1187         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
1188 </p>
1189 </dd>
1190 </dl></div>
1191 </div>
1192 </div>
1193 <div class="sect1">
1194 <h2 id="_notes">NOTES</h2>
1195 <div class="sectionbody">
1196 <div class="paragraph"><p><em>git gc</em> tries very hard not to delete objects that are referenced
1197 anywhere in your repository. In particular, it will keep not only
1198 objects referenced by your current set of branches and tags, but also
1199 objects referenced by the index, remote-tracking branches, reflogs
1200 (which may reference commits in branches that were later amended or
1201 rewound), and anything else in the refs/* namespace. Note that a note
1202 (of the kind created by <em>git notes</em>) attached to an object does not
1203 contribute in keeping the object alive. If you are expecting some
1204 objects to be deleted and they aren&#8217;t, check all of those locations
1205 and decide whether it makes sense in your case to remove those
1206 references.</p></div>
1207 <div class="paragraph"><p>On the other hand, when <em>git gc</em> runs concurrently with another process,
1208 there is a risk of it deleting an object that the other process is using
1209 but hasn&#8217;t created a reference to. This may just cause the other process
1210 to fail or may corrupt the repository if the other process later adds a
1211 reference to the deleted object. Git has two features that significantly
1212 mitigate this problem:</p></div>
1213 <div class="olist arabic"><ol class="arabic">
1214 <li>
1215 <p>
1216 Any object with modification time newer than the <code>--prune</code> date is kept,
1217   along with everything reachable from it.
1218 </p>
1219 </li>
1220 <li>
1221 <p>
1222 Most operations that add an object to the database update the
1223   modification time of the object if it is already present so that #1
1224   applies.
1225 </p>
1226 </li>
1227 </ol></div>
1228 <div class="paragraph"><p>However, these features fall short of a complete solution, so users who
1229 run commands concurrently have to live with some risk of corruption (which
1230 seems to be low in practice).</p></div>
1231 </div>
1232 </div>
1233 <div class="sect1">
1234 <h2 id="_hooks">HOOKS</h2>
1235 <div class="sectionbody">
1236 <div class="paragraph"><p>The <em>git gc --auto</em> command will run the <em>pre-auto-gc</em> hook.  See
1237 <a href="githooks.html">githooks(5)</a> for more information.</p></div>
1238 </div>
1239 </div>
1240 <div class="sect1">
1241 <h2 id="_see_also">SEE ALSO</h2>
1242 <div class="sectionbody">
1243 <div class="paragraph"><p><a href="git-prune.html">git-prune(1)</a>
1244 <a href="git-reflog.html">git-reflog(1)</a>
1245 <a href="git-repack.html">git-repack(1)</a>
1246 <a href="git-rerere.html">git-rerere(1)</a></p></div>
1247 </div>
1248 </div>
1249 <div class="sect1">
1250 <h2 id="_git">GIT</h2>
1251 <div class="sectionbody">
1252 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1253 </div>
1254 </div>
1255 </div>
1256 <div id="footnotes"><hr /></div>
1257 <div id="footer">
1258 <div id="footer-text">
1259 Last updated
1260  2023-10-18 13:44:22 PDT
1261 </div>
1262 </div>
1263 </body>
1264 </html>