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