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