1git-gc(1) 2========= 3 4NAME 5---- 6git-gc - Cleanup unnecessary files and optimize the local repository 7 8 9SYNOPSIS 10-------- 11[verse] 12'git gc' [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune] 13 14DESCRIPTION 15----------- 16Runs a number of housekeeping tasks within the current repository, 17such as compressing file revisions (to reduce disk space and increase 18performance) and removing unreachable objects which may have been 19created from prior invocations of 'git add'. 20 21Users are encouraged to run this task on a regular basis within 22each repository to maintain good disk space utilization and good 23operating performance. 24 25Some git commands may automatically run 'git gc'; see the `--auto` flag 26below for details. If you know what you're doing and all you want is to 27disable this behavior permanently without further considerations, just do: 28 29---------------------- 30$ git config --global gc.auto 0 31---------------------- 32 33OPTIONS 34------- 35 36--aggressive:: 37 Usually 'git gc' runs very quickly while providing good disk 38 space utilization and performance. This option will cause 39 'git gc' to more aggressively optimize the repository at the expense 40 of taking much more time. The effects of this optimization are 41 persistent, so this option only needs to be used occasionally; every 42 few hundred changesets or so. 43 44--auto:: 45 With this option, 'git gc' checks whether any housekeeping is 46 required; if not, it exits without performing any work. 47 Some git commands run `git gc --auto` after performing 48 operations that could create many loose objects. 49+ 50Housekeeping is required if there are too many loose objects or 51too many packs in the repository. If the number of loose objects 52exceeds the value of the `gc.auto` configuration variable, then 53all loose objects are combined into a single pack using 54`git repack -d -l`. Setting the value of `gc.auto` to 0 55disables automatic packing of loose objects. 56+ 57If the number of packs exceeds the value of `gc.autopacklimit`, 58then existing packs (except those marked with a `.keep` file) 59are consolidated into a single pack by using the `-A` option of 60'git repack'. Setting `gc.autopacklimit` to 0 disables 61automatic consolidation of packs. 62 63--prune=<date>:: 64 Prune loose objects older than date (default is 2 weeks ago, 65 overridable by the config variable `gc.pruneExpire`). This 66 option is on by default. 67 68--no-prune:: 69 Do not prune any loose objects. 70 71--quiet:: 72 Suppress all progress reports. 73 74Configuration 75------------- 76 77The optional configuration variable 'gc.reflogExpire' can be 78set to indicate how long historical entries within each branch's 79reflog should remain available in this repository. The setting is 80expressed as a length of time, for example '90 days' or '3 months'. 81It defaults to '90 days'. 82 83The optional configuration variable 'gc.reflogExpireUnreachable' 84can be set to indicate how long historical reflog entries which 85are not part of the current branch should remain available in 86this repository. These types of entries are generally created as 87a result of using `git commit --amend` or `git rebase` and are the 88commits prior to the amend or rebase occurring. Since these changes 89are not part of the current project most users will want to expire 90them sooner. This option defaults to '30 days'. 91 92The above two configuration variables can be given to a pattern. For 93example, this sets non-default expiry values only to remote-tracking 94branches: 95 96------------ 97[gc "refs/remotes/*"] 98 reflogExpire = never 99 reflogexpireUnreachable = 3 days 100------------ 101 102The optional configuration variable 'gc.rerereresolved' indicates 103how long records of conflicted merge you resolved earlier are 104kept. This defaults to 60 days. 105 106The optional configuration variable 'gc.rerereunresolved' indicates 107how long records of conflicted merge you have not resolved are 108kept. This defaults to 15 days. 109 110The optional configuration variable 'gc.packrefs' determines if 111'git gc' runs 'git pack-refs'. This can be set to "notbare" to enable 112it within all non-bare repos or it can be set to a boolean value. 113This defaults to true. 114 115The optional configuration variable 'gc.aggressiveWindow' controls how 116much time is spent optimizing the delta compression of the objects in 117the repository when the --aggressive option is specified. The larger 118the value, the more time is spent optimizing the delta compression. See 119the documentation for the --window' option in linkgit:git-repack[1] for 120more details. This defaults to 250. 121 122The optional configuration variable 'gc.pruneExpire' controls how old 123the unreferenced loose objects have to be before they are pruned. The 124default is "2 weeks ago". 125 126 127Notes 128----- 129 130'git gc' tries very hard to be safe about the garbage it collects. In 131particular, it will keep not only objects referenced by your current set 132of branches and tags, but also objects referenced by the index, 133remote-tracking branches, refs saved by 'git filter-branch' in 134refs/original/, or reflogs (which may reference commits in branches 135that were later amended or rewound). 136 137If you are expecting some objects to be collected and they aren't, check 138all of those locations and decide whether it makes sense in your case to 139remove those references. 140 141HOOKS 142----- 143 144The 'git gc --auto' command will run the 'pre-auto-gc' hook. See 145linkgit:githooks[5] for more information. 146 147 148SEE ALSO 149-------- 150linkgit:git-prune[1] 151linkgit:git-reflog[1] 152linkgit:git-repack[1] 153linkgit:git-rerere[1] 154 155GIT 156--- 157Part of the linkgit:git[1] suite