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 --prune=&lt;date&gt;
 820 </dt>
 821 <dd>
 822 <p>
 823         Prune loose objects older than date (default is 2 weeks ago,
 824         overridable by the config variable <code>gc.pruneExpire</code>).
 825         --prune=now prunes loose objects regardless of their age and
 826         increases the risk of corruption if another process is writing to
 827         the repository concurrently; see "NOTES" below. --prune is on by
 828         default.
 829 </p>
 830 </dd>
 831 <dt class="hdlist1">
 832 --no-prune
 833 </dt>
 834 <dd>
 835 <p>
 836         Do not prune any loose objects.
 837 </p>
 838 </dd>
 839 <dt class="hdlist1">
 840 --quiet
 841 </dt>
 842 <dd>
 843 <p>
 844         Suppress all progress reports.
 845 </p>
 846 </dd>
 847 <dt class="hdlist1">
 848 --force
 849 </dt>
 850 <dd>
 851 <p>
 852         Force <code>git gc</code> to run even if there may be another <code>git gc</code>
 853         instance running on this repository.
 854 </p>
 855 </dd>
 856 <dt class="hdlist1">
 857 --keep-largest-pack
 858 </dt>
 859 <dd>
 860 <p>
 861         All packs except the largest non-cruft pack, any packs marked
 862         with a <code>.keep</code> file, and any cruft pack(s) are consolidated into
 863         a single pack. When this option is used, <code>gc.bigPackThreshold</code>
 864         is ignored.
 865 </p>
 866 </dd>
 867 </dl></div>
 868 </div>
 869 </div>
 870 <div class="sect1">
 871 <h2 id="_aggressive">AGGRESSIVE</h2>
 872 <div class="sectionbody">
 873 <div class="paragraph"><p>When the <code>--aggressive</code> option is supplied, <a href="git-repack.html">git-repack(1)</a> will
 874 be invoked with the <code>-f</code> flag, which in turn will pass
 875 <code>--no-reuse-delta</code> to <a href="git-pack-objects.html">git-pack-objects(1)</a>. This will throw
 876 away any existing deltas and re-compute them, at the expense of
 877 spending much more time on the repacking.</p></div>
 878 <div class="paragraph"><p>The effects of this are mostly persistent, e.g. when packs and loose
 879 objects are coalesced into one another pack the existing deltas in
 880 that pack might get re-used, but there are also various cases where we
 881 might pick a sub-optimal delta from a newer pack instead.</p></div>
 882 <div class="paragraph"><p>Furthermore, supplying <code>--aggressive</code> will tweak the <code>--depth</code> and
 883 <code>--window</code> options passed to <a href="git-repack.html">git-repack(1)</a>. See the
 884 <code>gc.aggressiveDepth</code> and <code>gc.aggressiveWindow</code> settings below. By
 885 using a larger window size we&#8217;re more likely to find more optimal
 886 deltas.</p></div>
 887 <div class="paragraph"><p>It&#8217;s probably not worth it to use this option on a given repository
 888 without running tailored performance benchmarks on it. It takes a lot
 889 more time, and the resulting space/delta optimization may or may not
 890 be worth it. Not using this at all is the right trade-off for most
 891 users and their repositories.</p></div>
 892 </div>
 893 </div>
 894 <div class="sect1">
 895 <h2 id="_configuration">CONFIGURATION</h2>
 896 <div class="sectionbody">
 897 <div class="paragraph"><p>Everything below this line in this section is selectively included
 898 from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
 899 as what&#8217;s found there:</p></div>
 900 <div class="dlist"><dl>
 901 <dt class="hdlist1">
 902 gc.aggressiveDepth
 903 </dt>
 904 <dd>
 905 <p>
 906         The depth parameter used in the delta compression
 907         algorithm used by <em>git gc --aggressive</em>.  This defaults
 908         to 50, which is the default for the <code>--depth</code> option when
 909         <code>--aggressive</code> isn&#8217;t in use.
 910 </p>
 911 <div class="paragraph"><p>See the documentation for the <code>--depth</code> option in
 912 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
 913 </dd>
 914 <dt class="hdlist1">
 915 gc.aggressiveWindow
 916 </dt>
 917 <dd>
 918 <p>
 919         The window size parameter used in the delta compression
 920         algorithm used by <em>git gc --aggressive</em>.  This defaults
 921         to 250, which is a much more aggressive window size than
 922         the default <code>--window</code> of 10.
 923 </p>
 924 <div class="paragraph"><p>See the documentation for the <code>--window</code> option in
 925 <a href="git-repack.html">git-repack(1)</a> for more details.</p></div>
 926 </dd>
 927 <dt class="hdlist1">
 928 gc.auto
 929 </dt>
 930 <dd>
 931 <p>
 932         When there are approximately more than this many loose
 933         objects in the repository, <code>git gc --auto</code> will pack them.
 934         Some Porcelain commands use this command to perform a
 935         light-weight garbage collection from time to time.  The
 936         default value is 6700.
 937 </p>
 938 <div class="paragraph"><p>Setting this to 0 disables not only automatic packing based on the
 939 number of loose objects, but any other heuristic <code>git gc --auto</code> will
 940 otherwise use to determine if there&#8217;s work to do, such as
 941 <code>gc.autoPackLimit</code>.</p></div>
 942 </dd>
 943 <dt class="hdlist1">
 944 gc.autoPackLimit
 945 </dt>
 946 <dd>
 947 <p>
 948         When there are more than this many packs that are not
 949         marked with <code>*.keep</code> file in the repository, <code>git gc
 950         --auto</code> consolidates them into one larger pack.  The
 951         default value is 50.  Setting this to 0 disables it.
 952         Setting <code>gc.auto</code> to 0 will also disable this.
 953 </p>
 954 <div class="paragraph"><p>See the <code>gc.bigPackThreshold</code> configuration variable below. When in
 955 use, it&#8217;ll affect how the auto pack limit works.</p></div>
 956 </dd>
 957 <dt class="hdlist1">
 958 gc.autoDetach
 959 </dt>
 960 <dd>
 961 <p>
 962         Make <code>git gc --auto</code> return immediately and run in background
 963         if the system supports it. Default is true.
 964 </p>
 965 </dd>
 966 <dt class="hdlist1">
 967 gc.bigPackThreshold
 968 </dt>
 969 <dd>
 970 <p>
 971         If non-zero, all non-cruft packs larger than this limit are kept
 972         when <code>git gc</code> is run. This is very similar to
 973         <code>--keep-largest-pack</code> except that all non-cruft packs that meet
 974         the threshold are kept, not just the largest pack. Defaults to
 975         zero. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are supported.
 976 </p>
 977 <div class="paragraph"><p>Note that if the number of kept packs is more than gc.autoPackLimit,
 978 this configuration variable is ignored, all packs except the base pack
 979 will be repacked. After this the number of packs should go below
 980 gc.autoPackLimit and gc.bigPackThreshold should be respected again.</p></div>
 981 <div class="paragraph"><p>If the amount of memory estimated for <code>git repack</code> to run smoothly is
 982 not available and <code>gc.bigPackThreshold</code> is not set, the largest pack
 983 will also be excluded (this is the equivalent of running <code>git gc</code> with
 984 <code>--keep-largest-pack</code>).</p></div>
 985 </dd>
 986 <dt class="hdlist1">
 987 gc.writeCommitGraph
 988 </dt>
 989 <dd>
 990 <p>
 991         If true, then gc will rewrite the commit-graph file when
 992         <a href="git-gc.html">git-gc(1)</a> is run. When using <code>git gc --auto</code>
 993         the commit-graph will be updated if housekeeping is
 994         required. Default is true. See <a href="git-commit-graph.html">git-commit-graph(1)</a>
 995         for details.
 996 </p>
 997 </dd>
 998 <dt class="hdlist1">
 999 gc.logExpiry
1000 </dt>
1001 <dd>
1002 <p>
1003         If the file gc.log exists, then <code>git gc --auto</code> will print
1004         its content and exit with status zero instead of running
1005         unless that file is more than <em>gc.logExpiry</em> old.  Default is
1006         "1.day".  See <code>gc.pruneExpire</code> for more ways to specify its
1007         value.
1008 </p>
1009 </dd>
1010 <dt class="hdlist1">
1011 gc.packRefs
1012 </dt>
1013 <dd>
1014 <p>
1015         Running <code>git pack-refs</code> in a repository renders it
1016         unclonable by Git versions prior to 1.5.1.2 over dumb
1017         transports such as HTTP.  This variable determines whether
1018         <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code>
1019         to enable it within all non-bare repos or it can be set to a
1020         boolean value.  The default is <code>true</code>.
1021 </p>
1022 </dd>
1023 <dt class="hdlist1">
1024 gc.cruftPacks
1025 </dt>
1026 <dd>
1027 <p>
1028         Store unreachable objects in a cruft pack (see
1029         <a href="git-repack.html">git-repack(1)</a>) instead of as loose objects. The default
1030         is <code>true</code>.
1031 </p>
1032 </dd>
1033 <dt class="hdlist1">
1034 gc.pruneExpire
1035 </dt>
1036 <dd>
1037 <p>
1038         When <em>git gc</em> is run, it will call <em>prune --expire 2.weeks.ago</em>
1039         (and <em>repack --cruft --cruft-expiration 2.weeks.ago</em> if using
1040         cruft packs via <code>gc.cruftPacks</code> or <code>--cruft</code>).  Override the
1041         grace period with this config variable.  The value "now" may be
1042         used to disable this grace period and always prune unreachable
1043         objects immediately, or "never" may be used to suppress pruning.
1044         This feature helps prevent corruption when <em>git gc</em> runs
1045         concurrently with another process writing to the repository; see
1046         the "NOTES" section of <a href="git-gc.html">git-gc(1)</a>.
1047 </p>
1048 </dd>
1049 <dt class="hdlist1">
1050 gc.worktreePruneExpire
1051 </dt>
1052 <dd>
1053 <p>
1054         When <em>git gc</em> is run, it calls
1055         <em>git worktree prune --expire 3.months.ago</em>.
1056         This config variable can be used to set a different grace
1057         period. The value "now" may be used to disable the grace
1058         period and prune <code>$GIT_DIR/worktrees</code> immediately, or "never"
1059         may be used to suppress pruning.
1060 </p>
1061 </dd>
1062 <dt class="hdlist1">
1063 gc.reflogExpire
1064 </dt>
1065 <dt class="hdlist1">
1066 gc.&lt;pattern&gt;.reflogExpire
1067 </dt>
1068 <dd>
1069 <p>
1070         <em>git reflog expire</em> removes reflog entries older than
1071         this time; defaults to 90 days. The value "now" expires all
1072         entries immediately, and "never" suppresses expiration
1073         altogether. With "&lt;pattern&gt;" (e.g.
1074         "refs/stash") in the middle the setting applies only to
1075         the refs that match the &lt;pattern&gt;.
1076 </p>
1077 </dd>
1078 <dt class="hdlist1">
1079 gc.reflogExpireUnreachable
1080 </dt>
1081 <dt class="hdlist1">
1082 gc.&lt;pattern&gt;.reflogExpireUnreachable
1083 </dt>
1084 <dd>
1085 <p>
1086         <em>git reflog expire</em> removes reflog entries older than
1087         this time and are not reachable from the current tip;
1088         defaults to 30 days. The value "now" expires all entries
1089         immediately, and "never" suppresses expiration altogether.
1090         With "&lt;pattern&gt;" (e.g. "refs/stash")
1091         in the middle, the setting applies only to the refs that
1092         match the &lt;pattern&gt;.
1093 </p>
1094 <div class="paragraph"><p>These types of entries are generally created as a result of using <code>git
1095 commit --amend</code> or <code>git rebase</code> and are the commits prior to the amend
1096 or rebase occurring.  Since these changes are not part of the current
1097 project most users will want to expire them sooner, which is why the
1098 default is more aggressive than <code>gc.reflogExpire</code>.</p></div>
1099 </dd>
1100 <dt class="hdlist1">
1101 gc.rerereResolved
1102 </dt>
1103 <dd>
1104 <p>
1105         Records of conflicted merge you resolved earlier are
1106         kept for this many days when <em>git rerere gc</em> is run.
1107         You can also use more human-readable "1.month.ago", etc.
1108         The default is 60 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
1109 </p>
1110 </dd>
1111 <dt class="hdlist1">
1112 gc.rerereUnresolved
1113 </dt>
1114 <dd>
1115 <p>
1116         Records of conflicted merge you have not resolved are
1117         kept for this many days when <em>git rerere gc</em> is run.
1118         You can also use more human-readable "1.month.ago", etc.
1119         The default is 15 days.  See <a href="git-rerere.html">git-rerere(1)</a>.
1120 </p>
1121 </dd>
1122 </dl></div>
1123 </div>
1124 </div>
1125 <div class="sect1">
1126 <h2 id="_notes">NOTES</h2>
1127 <div class="sectionbody">
1128 <div class="paragraph"><p><em>git gc</em> tries very hard not to delete objects that are referenced
1129 anywhere in your repository. In particular, it will keep not only
1130 objects referenced by your current set of branches and tags, but also
1131 objects referenced by the index, remote-tracking branches, reflogs
1132 (which may reference commits in branches that were later amended or
1133 rewound), and anything else in the refs/* namespace. Note that a note
1134 (of the kind created by <em>git notes</em>) attached to an object does not
1135 contribute in keeping the object alive. If you are expecting some
1136 objects to be deleted and they aren&#8217;t, check all of those locations
1137 and decide whether it makes sense in your case to remove those
1138 references.</p></div>
1139 <div class="paragraph"><p>On the other hand, when <em>git gc</em> runs concurrently with another process,
1140 there is a risk of it deleting an object that the other process is using
1141 but hasn&#8217;t created a reference to. This may just cause the other process
1142 to fail or may corrupt the repository if the other process later adds a
1143 reference to the deleted object. Git has two features that significantly
1144 mitigate this problem:</p></div>
1145 <div class="olist arabic"><ol class="arabic">
1146 <li>
1147 <p>
1148 Any object with modification time newer than the <code>--prune</code> date is kept,
1149   along with everything reachable from it.
1150 </p>
1151 </li>
1152 <li>
1153 <p>
1154 Most operations that add an object to the database update the
1155   modification time of the object if it is already present so that #1
1156   applies.
1157 </p>
1158 </li>
1159 </ol></div>
1160 <div class="paragraph"><p>However, these features fall short of a complete solution, so users who
1161 run commands concurrently have to live with some risk of corruption (which
1162 seems to be low in practice).</p></div>
1163 </div>
1164 </div>
1165 <div class="sect1">
1166 <h2 id="_hooks">HOOKS</h2>
1167 <div class="sectionbody">
1168 <div class="paragraph"><p>The <em>git gc --auto</em> command will run the <em>pre-auto-gc</em> hook.  See
1169 <a href="githooks.html">githooks(5)</a> for more information.</p></div>
1170 </div>
1171 </div>
1172 <div class="sect1">
1173 <h2 id="_see_also">SEE ALSO</h2>
1174 <div class="sectionbody">
1175 <div class="paragraph"><p><a href="git-prune.html">git-prune(1)</a>
1176 <a href="git-reflog.html">git-reflog(1)</a>
1177 <a href="git-repack.html">git-repack(1)</a>
1178 <a href="git-rerere.html">git-rerere(1)</a></p></div>
1179 </div>
1180 </div>
1181 <div class="sect1">
1182 <h2 id="_git">GIT</h2>
1183 <div class="sectionbody">
1184 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1185 </div>
1186 </div>
1187 </div>
1188 <div id="footnotes"><hr /></div>
1189 <div id="footer">
1190 <div id="footer-text">
1191 Last updated
1192  2023-04-28 16:26:53 PDT
1193 </div>
1194 </div>
1195 </body>
1196 </html>