git-gc.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.4.5" />
   7 <title>git-gc(1)</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Overrides for manpage documents */
 343 h1 {
 344   padding-top: 0.5em;
 345   padding-bottom: 0.5em;
 346   border-top: 2px solid silver;
 347   border-bottom: 2px solid silver;
 348 }
 349 h2 {
 350   border-style: none;
 351 }
 352 div.sectionbody {
 353   margin-left: 5%;
 354 }
 355
 356 @media print {
 357   div#toc { display: none; }
 358 }
 359
 360 /* Workarounds for IE6's broken and incomplete CSS2. */
 361
 362 div.sidebar-content {
 363   background: #ffffee;
 364   border: 1px solid silver;
 365   padding: 0.5em;
 366 }
 367 div.sidebar-title, div.image-title {
 368   color: #527bbd;
 369   font-family: sans-serif;
 370   font-weight: bold;
 371   margin-top: 0.0em;
 372   margin-bottom: 0.5em;
 373 }
 374
 375 div.listingblock div.content {
 376   border: 1px solid silver;
 377   background: #f4f4f4;
 378   padding: 0.5em;
 379 }
 380
 381 div.quoteblock-attribution {
 382   padding-top: 0.5em;
 383   text-align: right;
 384 }
 385
 386 div.verseblock-content {
 387   white-space: pre;
 388 }
 389 div.verseblock-attribution {
 390   padding-top: 0.75em;
 391   text-align: left;
 392 }
 393
 394 div.exampleblock-content {
 395   border-left: 2px solid silver;
 396   padding-left: 0.5em;
 397 }
 398
 399 /* IE6 sets dynamically generated links as visited. */
 400 div#toc a:visited { color: blue; }
 401 </style>
 402 </head>
 403 <body>
 404 <div id="header">
 405 <h1>
 406 git-gc(1) Manual Page
 407 </h1>
 408 <h2>NAME</h2>
 409 <div class="sectionbody">
 410 <p>git-gc -
 411    Cleanup unnecessary files and optimize the local repository
 412 </p>
 413 </div>
 414 </div>
 415 <h2 id="_synopsis">SYNOPSIS</h2>
 416 <div class="sectionbody">
 417 <div class="verseblock">
 418 <div class="verseblock-content"><em>git gc</em> [--aggressive] [--auto] [--quiet] [--prune=&lt;date&gt; | --no-prune]</div>
 419 <div class="verseblock-attribution">
 420 </div></div>
 421 </div>
 422 <h2 id="_description">DESCRIPTION</h2>
 423 <div class="sectionbody">
 424 <div class="paragraph"><p>Runs a number of housekeeping tasks within the current repository,
 425 such as compressing file revisions (to reduce disk space and increase
 426 performance) and removing unreachable objects which may have been
 427 created from prior invocations of <em>git add</em>.</p></div>
 428 <div class="paragraph"><p>Users are encouraged to run this task on a regular basis within
 429 each repository to maintain good disk space utilization and good
 430 operating performance.</p></div>
 431 <div class="paragraph"><p>Some git commands may automatically run <em>git gc</em>; see the <tt>--auto</tt> flag
 432 below for details. If you know what you&#8217;re doing and all you want is to
 433 disable this behavior permanently without further considerations, just do:</p></div>
 434 <div class="listingblock">
 435 <div class="content">
 436 <pre><tt>$ git config --global gc.auto 0</tt></pre>
 437 </div></div>
 438 </div>
 439 <h2 id="_options">OPTIONS</h2>
 440 <div class="sectionbody">
 441 <div class="dlist"><dl>
 442 <dt class="hdlist1">
 443 --aggressive
 444 </dt>
 445 <dd>
 446 <p>
 447         Usually <em>git gc</em> runs very quickly while providing good disk
 448         space utilization and performance.  This option will cause
 449         <em>git gc</em> to more aggressively optimize the repository at the expense
 450         of taking much more time.  The effects of this optimization are
 451         persistent, so this option only needs to be used occasionally; every
 452         few hundred changesets or so.
 453 </p>
 454 </dd>
 455 <dt class="hdlist1">
 456 --auto
 457 </dt>
 458 <dd>
 459 <p>
 460         With this option, <em>git gc</em> checks whether any housekeeping is
 461         required; if not, it exits without performing any work.
 462         Some git commands run <tt>git gc --auto</tt> after performing
 463         operations that could create many loose objects.
 464 </p>
 465 <div class="paragraph"><p>Housekeeping is required if there are too many loose objects or
 466 too many packs in the repository. If the number of loose objects
 467 exceeds the value of the <tt>gc.auto</tt> configuration variable, then
 468 all loose objects are combined into a single pack using
 469 <tt>git repack -d -l</tt>.  Setting the value of <tt>gc.auto</tt> to 0
 470 disables automatic packing of loose objects.</p></div>
 471 <div class="paragraph"><p>If the number of packs exceeds the value of <tt>gc.autopacklimit</tt>,
 472 then existing packs (except those marked with a <tt>.keep</tt> file)
 473 are consolidated into a single pack by using the <tt>-A</tt> option of
 474 <em>git repack</em>. Setting <tt>gc.autopacklimit</tt> to 0 disables
 475 automatic consolidation of packs.</p></div>
 476 </dd>
 477 <dt class="hdlist1">
 478 --prune=&lt;date&gt;
 479 </dt>
 480 <dd>
 481 <p>
 482         Prune loose objects older than date (default is 2 weeks ago,
 483         overridable by the config variable <tt>gc.pruneExpire</tt>).  This
 484         option is on by default.
 485 </p>
 486 </dd>
 487 <dt class="hdlist1">
 488 --no-prune
 489 </dt>
 490 <dd>
 491 <p>
 492         Do not prune any loose objects.
 493 </p>
 494 </dd>
 495 <dt class="hdlist1">
 496 --quiet
 497 </dt>
 498 <dd>
 499 <p>
 500         Suppress all progress reports.
 501 </p>
 502 </dd>
 503 </dl></div>
 504 </div>
 505 <h2 id="_configuration">Configuration</h2>
 506 <div class="sectionbody">
 507 <div class="paragraph"><p>The optional configuration variable <em>gc.reflogExpire</em> can be
 508 set to indicate how long historical entries within each branch&#8217;s
 509 reflog should remain available in this repository.  The setting is
 510 expressed as a length of time, for example <em>90 days</em> or <em>3 months</em>.
 511 It defaults to <em>90 days</em>.</p></div>
 512 <div class="paragraph"><p>The optional configuration variable <em>gc.reflogExpireUnreachable</em>
 513 can be set to indicate how long historical reflog entries which
 514 are not part of the current branch should remain available in
 515 this repository.  These types of entries are generally created as
 516 a result of using <tt>git commit --amend</tt> or <tt>git rebase</tt> and are the
 517 commits prior to the amend or rebase occurring.  Since these changes
 518 are not part of the current project most users will want to expire
 519 them sooner.  This option defaults to <em>30 days</em>.</p></div>
 520 <div class="paragraph"><p>The above two configuration variables can be given to a pattern.  For
 521 example, this sets non-default expiry values only to remote-tracking
 522 branches:</p></div>
 523 <div class="listingblock">
 524 <div class="content">
 525 <pre><tt>[gc "refs/remotes/*"]
 526         reflogExpire = never
 527         reflogexpireUnreachable = 3 days</tt></pre>
 528 </div></div>
 529 <div class="paragraph"><p>The optional configuration variable <em>gc.rerereresolved</em> indicates
 530 how long records of conflicted merge you resolved earlier are
 531 kept.  This defaults to 60 days.</p></div>
 532 <div class="paragraph"><p>The optional configuration variable <em>gc.rerereunresolved</em> indicates
 533 how long records of conflicted merge you have not resolved are
 534 kept.  This defaults to 15 days.</p></div>
 535 <div class="paragraph"><p>The optional configuration variable <em>gc.packrefs</em> determines if
 536 <em>git gc</em> runs <em>git pack-refs</em>. This can be set to "notbare" to enable
 537 it within all non-bare repos or it can be set to a boolean value.
 538 This defaults to true.</p></div>
 539 <div class="paragraph"><p>The optional configuration variable <em>gc.aggressiveWindow</em> controls how
 540 much time is spent optimizing the delta compression of the objects in
 541 the repository when the --aggressive option is specified.  The larger
 542 the value, the more time is spent optimizing the delta compression.  See
 543 the documentation for the --window' option in <a href="git-repack.html">git-repack(1)</a> for
 544 more details.  This defaults to 250.</p></div>
 545 <div class="paragraph"><p>The optional configuration variable <em>gc.pruneExpire</em> controls how old
 546 the unreferenced loose objects have to be before they are pruned.  The
 547 default is "2 weeks ago".</p></div>
 548 </div>
 549 <h2 id="_notes">Notes</h2>
 550 <div class="sectionbody">
 551 <div class="paragraph"><p><em>git gc</em> tries very hard to be safe about the garbage it collects. In
 552 particular, it will keep not only objects referenced by your current set
 553 of branches and tags, but also objects referenced by the index,
 554 remote-tracking branches, refs saved by <em>git filter-branch</em> in
 555 refs/original/, or reflogs (which may reference commits in branches
 556 that were later amended or rewound).</p></div>
 557 <div class="paragraph"><p>If you are expecting some objects to be collected and they aren&#8217;t, check
 558 all of those locations and decide whether it makes sense in your case to
 559 remove those references.</p></div>
 560 </div>
 561 <h2 id="_hooks">HOOKS</h2>
 562 <div class="sectionbody">
 563 <div class="paragraph"><p>The <em>git gc --auto</em> command will run the <em>pre-auto-gc</em> hook.  See
 564 <a href="githooks.html">githooks(5)</a> for more information.</p></div>
 565 </div>
 566 <h2 id="_see_also">SEE ALSO</h2>
 567 <div class="sectionbody">
 568 <div class="paragraph"><p><a href="git-prune.html">git-prune(1)</a>
 569 <a href="git-reflog.html">git-reflog(1)</a>
 570 <a href="git-repack.html">git-repack(1)</a>
 571 <a href="git-rerere.html">git-rerere(1)</a></p></div>
 572 </div>
 573 <h2 id="_git">GIT</h2>
 574 <div class="sectionbody">
 575 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 576 </div>
 577 <div id="footer">
 578 <div id="footer-text">
 579 Last updated 2011-07-23 00:49:30 UTC
 580 </div>
 581 </div>
 582 </body>
 583 </html>