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">
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">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.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
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.5em;
129 div
.content
{ /* Block element content. */
133 /* Block element titles. */
134 div
.title
, caption
.title
{
136 font-family: sans-serif
;
140 margin-bottom: 0.5em;
146 td div
.title:first-child
{
149 div
.content div
.title:first-child
{
152 div
.content
+ div
.title
{
156 div
.sidebarblock
> div
.content
{
158 border: 1px solid silver
;
162 div
.listingblock
> div
.content
{
163 border: 1px solid silver
;
172 div
.quoteblock
> div
.attribution
{
181 div
.verseblock
> div
.content
{
184 div
.verseblock
> div
.attribution
{
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div
.verseblock
+ div
.attribution
{
193 div
.admonitionblock
.icon
{
197 text-decoration: underline
;
199 padding-right: 0.5em;
201 div
.admonitionblock td
.content
{
203 border-left: 2px solid silver
;
206 div
.exampleblock
> div
.content
{
207 border-left: 2px solid silver
;
211 div
.imageblock div
.content
{ padding-left: 0; }
212 span
.image img
{ border-style: none
; }
213 a
.image:visited
{ color: white
; }
217 margin-bottom: 0.8em;
230 list-style-position: outside
;
233 list-style-type: decimal
;
236 list-style-type: lower-alpha
;
239 list-style-type: upper-alpha
;
242 list-style-type: lower-roman
;
245 list-style-type: upper-roman
;
248 div
.compact ul
, div
.compact ol
,
249 div
.compact p
, div
.compact p
,
250 div
.compact div
, div
.compact div
{
252 margin-bottom: 0.1em;
255 div
.tableblock
> table
{
256 border: 3px solid
#527bbd;
259 font-family: sans-serif
;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div
.tableblock
> table
[frame
="void"] {
275 div
.tableblock
> table
[frame
="hsides"] {
276 border-left-style: none
;
277 border-right-style: none
;
279 div
.tableblock
> table
[frame
="vsides"] {
280 border-top-style: none
;
281 border-bottom-style: none
;
287 margin-bottom: 0.8em;
290 padding-bottom: 15px;
292 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
298 padding-right: 0.8em;
304 div
.hdlist
.compact tr
{
314 div#footer-badges
{ display: none
; }
319 font-family: sans-serif
;
323 margin-bottom: 0.1em;
326 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
342 /* Overrides for manpage documents */
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver
;
347 border-bottom: 2px solid silver
;
357 div#toc
{ display: none
; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div
.sidebar-content
{
364 border: 1px solid silver
;
367 div
.sidebar-title
, div
.image-title
{
369 font-family: sans-serif
;
372 margin-bottom: 0.5em;
375 div
.listingblock div
.content
{
376 border: 1px solid silver
;
381 div
.quoteblock-attribution
{
386 div
.verseblock-content
{
389 div
.verseblock-attribution
{
394 div
.exampleblock-content
{
395 border-left: 2px solid silver
;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc
a:visited
{ color: blue
; }
406 git-gc(
1) Manual Page
409 <div class=
"sectionbody">
411 Cleanup unnecessary files and optimize the local repository
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=
<date
> | --no-prune]
</div>
419 <div class=
"verseblock-attribution">
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
’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>
439 <h2 id=
"_options">OPTIONS
</h2>
440 <div class=
"sectionbody">
441 <div class=
"dlist"><dl>
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.
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.
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>
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.
492 Do not prune any loose objects.
500 Suppress all progress reports.
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
’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
523 <div class=
"listingblock">
524 <div class=
"content">
525 <pre><tt>[gc
"refs/remotes/*"]
527 reflogexpireUnreachable =
3 days
</tt></pre>
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>
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
’t, check
558 all of those locations and decide whether it makes sense in your case to
559 remove those references.
</p></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>
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>
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>
578 <div id=
"footer-text">
579 Last updated
2011-
07-
23 00:
49:
30 UTC