Autogenerated HTML docs for v1.7.7-237-g34c44
[git/jnareb-git.git] / git-gc.html
blob69c990bcb8f3955ff893c4821f3d9786541a57be
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.5.2" />
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 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
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;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
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;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
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.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 git-gc(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-gc -
578 Cleanup unnecessary files and optimize the local repository
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git gc</em> [--aggressive] [--auto] [--quiet] [--prune=&lt;date&gt; | --no-prune]</div>
587 <div class="verseblock-attribution">
588 </div></div>
589 </div>
590 <h2 id="_description">DESCRIPTION</h2>
591 <div class="sectionbody">
592 <div class="paragraph"><p>Runs a number of housekeeping tasks within the current repository,
593 such as compressing file revisions (to reduce disk space and increase
594 performance) and removing unreachable objects which may have been
595 created from prior invocations of <em>git add</em>.</p></div>
596 <div class="paragraph"><p>Users are encouraged to run this task on a regular basis within
597 each repository to maintain good disk space utilization and good
598 operating performance.</p></div>
599 <div class="paragraph"><p>Some git commands may automatically run <em>git gc</em>; see the <tt>--auto</tt> flag
600 below for details. If you know what you&#8217;re doing and all you want is to
601 disable this behavior permanently without further considerations, just do:</p></div>
602 <div class="listingblock">
603 <div class="content">
604 <pre><tt>$ git config --global gc.auto 0</tt></pre>
605 </div></div>
606 </div>
607 <h2 id="_options">OPTIONS</h2>
608 <div class="sectionbody">
609 <div class="dlist"><dl>
610 <dt class="hdlist1">
611 --aggressive
612 </dt>
613 <dd>
615 Usually <em>git gc</em> runs very quickly while providing good disk
616 space utilization and performance. This option will cause
617 <em>git gc</em> to more aggressively optimize the repository at the expense
618 of taking much more time. The effects of this optimization are
619 persistent, so this option only needs to be used occasionally; every
620 few hundred changesets or so.
621 </p>
622 </dd>
623 <dt class="hdlist1">
624 --auto
625 </dt>
626 <dd>
628 With this option, <em>git gc</em> checks whether any housekeeping is
629 required; if not, it exits without performing any work.
630 Some git commands run <tt>git gc --auto</tt> after performing
631 operations that could create many loose objects.
632 </p>
633 <div class="paragraph"><p>Housekeeping is required if there are too many loose objects or
634 too many packs in the repository. If the number of loose objects
635 exceeds the value of the <tt>gc.auto</tt> configuration variable, then
636 all loose objects are combined into a single pack using
637 <tt>git repack -d -l</tt>. Setting the value of <tt>gc.auto</tt> to 0
638 disables automatic packing of loose objects.</p></div>
639 <div class="paragraph"><p>If the number of packs exceeds the value of <tt>gc.autopacklimit</tt>,
640 then existing packs (except those marked with a <tt>.keep</tt> file)
641 are consolidated into a single pack by using the <tt>-A</tt> option of
642 <em>git repack</em>. Setting <tt>gc.autopacklimit</tt> to 0 disables
643 automatic consolidation of packs.</p></div>
644 </dd>
645 <dt class="hdlist1">
646 --prune=&lt;date&gt;
647 </dt>
648 <dd>
650 Prune loose objects older than date (default is 2 weeks ago,
651 overridable by the config variable <tt>gc.pruneExpire</tt>). This
652 option is on by default.
653 </p>
654 </dd>
655 <dt class="hdlist1">
656 --no-prune
657 </dt>
658 <dd>
660 Do not prune any loose objects.
661 </p>
662 </dd>
663 <dt class="hdlist1">
664 --quiet
665 </dt>
666 <dd>
668 Suppress all progress reports.
669 </p>
670 </dd>
671 </dl></div>
672 </div>
673 <h2 id="_configuration">Configuration</h2>
674 <div class="sectionbody">
675 <div class="paragraph"><p>The optional configuration variable <em>gc.reflogExpire</em> can be
676 set to indicate how long historical entries within each branch&#8217;s
677 reflog should remain available in this repository. The setting is
678 expressed as a length of time, for example <em>90 days</em> or <em>3 months</em>.
679 It defaults to <em>90 days</em>.</p></div>
680 <div class="paragraph"><p>The optional configuration variable <em>gc.reflogExpireUnreachable</em>
681 can be set to indicate how long historical reflog entries which
682 are not part of the current branch should remain available in
683 this repository. These types of entries are generally created as
684 a result of using <tt>git commit --amend</tt> or <tt>git rebase</tt> and are the
685 commits prior to the amend or rebase occurring. Since these changes
686 are not part of the current project most users will want to expire
687 them sooner. This option defaults to <em>30 days</em>.</p></div>
688 <div class="paragraph"><p>The above two configuration variables can be given to a pattern. For
689 example, this sets non-default expiry values only to remote-tracking
690 branches:</p></div>
691 <div class="listingblock">
692 <div class="content">
693 <pre><tt>[gc "refs/remotes/*"]
694 reflogExpire = never
695 reflogexpireUnreachable = 3 days</tt></pre>
696 </div></div>
697 <div class="paragraph"><p>The optional configuration variable <em>gc.rerereresolved</em> indicates
698 how long records of conflicted merge you resolved earlier are
699 kept. This defaults to 60 days.</p></div>
700 <div class="paragraph"><p>The optional configuration variable <em>gc.rerereunresolved</em> indicates
701 how long records of conflicted merge you have not resolved are
702 kept. This defaults to 15 days.</p></div>
703 <div class="paragraph"><p>The optional configuration variable <em>gc.packrefs</em> determines if
704 <em>git gc</em> runs <em>git pack-refs</em>. This can be set to "notbare" to enable
705 it within all non-bare repos or it can be set to a boolean value.
706 This defaults to true.</p></div>
707 <div class="paragraph"><p>The optional configuration variable <em>gc.aggressiveWindow</em> controls how
708 much time is spent optimizing the delta compression of the objects in
709 the repository when the --aggressive option is specified. The larger
710 the value, the more time is spent optimizing the delta compression. See
711 the documentation for the --window' option in <a href="git-repack.html">git-repack(1)</a> for
712 more details. This defaults to 250.</p></div>
713 <div class="paragraph"><p>The optional configuration variable <em>gc.pruneExpire</em> controls how old
714 the unreferenced loose objects have to be before they are pruned. The
715 default is "2 weeks ago".</p></div>
716 </div>
717 <h2 id="_notes">Notes</h2>
718 <div class="sectionbody">
719 <div class="paragraph"><p><em>git gc</em> tries very hard to be safe about the garbage it collects. In
720 particular, it will keep not only objects referenced by your current set
721 of branches and tags, but also objects referenced by the index,
722 remote-tracking branches, refs saved by <em>git filter-branch</em> in
723 refs/original/, or reflogs (which may reference commits in branches
724 that were later amended or rewound).</p></div>
725 <div class="paragraph"><p>If you are expecting some objects to be collected and they aren&#8217;t, check
726 all of those locations and decide whether it makes sense in your case to
727 remove those references.</p></div>
728 </div>
729 <h2 id="_hooks">HOOKS</h2>
730 <div class="sectionbody">
731 <div class="paragraph"><p>The <em>git gc --auto</em> command will run the <em>pre-auto-gc</em> hook. See
732 <a href="githooks.html">githooks(5)</a> for more information.</p></div>
733 </div>
734 <h2 id="_see_also">SEE ALSO</h2>
735 <div class="sectionbody">
736 <div class="paragraph"><p><a href="git-prune.html">git-prune(1)</a>
737 <a href="git-reflog.html">git-reflog(1)</a>
738 <a href="git-repack.html">git-repack(1)</a>
739 <a href="git-rerere.html">git-rerere(1)</a></p></div>
740 </div>
741 <h2 id="_git">GIT</h2>
742 <div class="sectionbody">
743 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
744 </div>
745 </div>
746 <div id="footnotes"><hr /></div>
747 <div id="footer">
748 <div id="footer-text">
749 Last updated 2011-09-21 23:01:14 PDT
750 </div>
751 </div>
752 </body>
753 </html>