Autogenerated HTML docs for v1.7.4-rc1-14-g7fad99
[git/jnareb-git.git] / git-repack.html
blobed306ed516ca09f983b5772667f95cb4d19ad0e2
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.4.5" />
7 <title>git-repack(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.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
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 {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
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;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-repack(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-repack -
411 Pack unpacked objects in a repository
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p><em>git repack</em> [-a] [-A] [-d] [-f] [-F] [-l] [-n] [-q] [--window=&lt;n&gt;] [--depth=&lt;n&gt;]</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="paragraph"><p>This script is used to combine all objects that do not currently
422 reside in a "pack", into a pack. It can also be used to re-organize
423 existing packs into a single, more efficient pack.</p></div>
424 <div class="paragraph"><p>A pack is a collection of objects, individually compressed, with
425 delta compression applied, stored in a single file, with an
426 associated index file.</p></div>
427 <div class="paragraph"><p>Packs are used to reduce the load on mirror systems, backup
428 engines, disk storage, etc.</p></div>
429 </div>
430 <h2 id="_options">OPTIONS</h2>
431 <div class="sectionbody">
432 <div class="dlist"><dl>
433 <dt class="hdlist1">
435 </dt>
436 <dd>
438 Instead of incrementally packing the unpacked objects,
439 pack everything referenced into a single pack.
440 Especially useful when packing a repository that is used
441 for private development. Use
442 with <em>-d</em>. This will clean up the objects that <tt>git prune</tt>
443 leaves behind, but <tt>git fsck --full</tt> shows as
444 dangling.
445 </p>
446 <div class="paragraph"><p>Note that users fetching over dumb protocols will have to fetch the
447 whole new pack in order to get any contained object, no matter how many
448 other objects in that pack they already have locally.</p></div>
449 </dd>
450 <dt class="hdlist1">
452 </dt>
453 <dd>
455 Same as <tt>-a</tt>, unless <em>-d</em> is used. Then any unreachable
456 objects in a previous pack become loose, unpacked objects,
457 instead of being left in the old pack. Unreachable objects
458 are never intentionally added to a pack, even when repacking.
459 This option prevents unreachable objects from being immediately
460 deleted by way of being left in the old pack and then
461 removed. Instead, the loose unreachable objects
462 will be pruned according to normal expiry rules
463 with the next <em>git gc</em> invocation. See <a href="git-gc.html">git-gc(1)</a>.
464 </p>
465 </dd>
466 <dt class="hdlist1">
468 </dt>
469 <dd>
471 After packing, if the newly created packs make some
472 existing packs redundant, remove the redundant packs.
473 Also run <em>git prune-packed</em> to remove redundant
474 loose object files.
475 </p>
476 </dd>
477 <dt class="hdlist1">
479 </dt>
480 <dd>
482 Pass the <tt>--local</tt> option to <em>git pack-objects</em>. See
483 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
484 </p>
485 </dd>
486 <dt class="hdlist1">
488 </dt>
489 <dd>
491 Pass the <tt>--no-reuse-delta</tt> option to <tt>git-pack-objects</tt>, see
492 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
493 </p>
494 </dd>
495 <dt class="hdlist1">
497 </dt>
498 <dd>
500 Pass the <tt>--no-reuse-object</tt> option to <tt>git-pack-objects</tt>, see
501 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
502 </p>
503 </dd>
504 <dt class="hdlist1">
506 </dt>
507 <dd>
509 Pass the <tt>-q</tt> option to <em>git pack-objects</em>. See
510 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
511 </p>
512 </dd>
513 <dt class="hdlist1">
515 </dt>
516 <dd>
518 Do not update the server information with
519 <em>git update-server-info</em>. This option skips
520 updating local catalog files needed to publish
521 this repository (or a direct copy of it)
522 over HTTP or FTP. See <a href="git-update-server-info.html">git-update-server-info(1)</a>.
523 </p>
524 </dd>
525 <dt class="hdlist1">
526 --window=&lt;n&gt;
527 </dt>
528 <dt class="hdlist1">
529 --depth=&lt;n&gt;
530 </dt>
531 <dd>
533 These two options affect how the objects contained in the pack are
534 stored using delta compression. The objects are first internally
535 sorted by type, size and optionally names and compared against the
536 other objects within <tt>--window</tt> to see if using delta compression saves
537 space. <tt>--depth</tt> limits the maximum delta depth; making it too deep
538 affects the performance on the unpacker side, because delta data needs
539 to be applied that many times to get to the necessary object.
540 The default value for --window is 10 and --depth is 50.
541 </p>
542 </dd>
543 <dt class="hdlist1">
544 --window-memory=&lt;n&gt;
545 </dt>
546 <dd>
548 This option provides an additional limit on top of <tt>--window</tt>;
549 the window size will dynamically scale down so as to not take
550 up more than <em>&lt;n&gt;</em> bytes in memory. This is useful in
551 repositories with a mix of large and small objects to not run
552 out of memory with a large window, but still be able to take
553 advantage of the large window for the smaller objects. The
554 size can be suffixed with "k", "m", or "g".
555 <tt>--window-memory=0</tt> makes memory usage unlimited, which is the
556 default.
557 </p>
558 </dd>
559 <dt class="hdlist1">
560 --max-pack-size=&lt;n&gt;
561 </dt>
562 <dd>
564 Maximum size of each output pack file. The size can be suffixed with
565 "k", "m", or "g". The minimum size allowed is limited to 1 MiB.
566 If specified, multiple packfiles may be created.
567 The default is unlimited, unless the config variable
568 <tt>pack.packSizeLimit</tt> is set.
569 </p>
570 </dd>
571 </dl></div>
572 </div>
573 <h2 id="_configuration">Configuration</h2>
574 <div class="sectionbody">
575 <div class="paragraph"><p>By default, the command passes <tt>--delta-base-offset</tt> option to
576 <em>git pack-objects</em>; this typically results in slightly smaller packs,
577 but the generated packs are incompatible with versions of Git older than
578 version 1.4.4. If you need to share your repository with such ancient Git
579 versions, either directly or via the dumb http or rsync protocol, then you
580 need to set the configuration variable <tt>repack.UseDeltaBaseOffset</tt> to
581 "false" and repack. Access from old Git versions over the native protocol
582 is unaffected by this option as the conversion is performed on the fly
583 as needed in that case.</p></div>
584 </div>
585 <h2 id="_author">Author</h2>
586 <div class="sectionbody">
587 <div class="paragraph"><p>Written by Linus Torvalds &lt;<a href="mailto:torvalds@osdl.org">torvalds@osdl.org</a>&gt;</p></div>
588 </div>
589 <h2 id="_documentation">Documentation</h2>
590 <div class="sectionbody">
591 <div class="paragraph"><p>Documentation by Ryan Anderson &lt;<a href="mailto:ryan@michonline.com">ryan@michonline.com</a>&gt;</p></div>
592 </div>
593 <h2 id="_see_also">SEE ALSO</h2>
594 <div class="sectionbody">
595 <div class="paragraph"><p><a href="git-pack-objects.html">git-pack-objects(1)</a>
596 <a href="git-prune-packed.html">git-prune-packed(1)</a></p></div>
597 </div>
598 <h2 id="_git">GIT</h2>
599 <div class="sectionbody">
600 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
601 </div>
602 <div id="footer">
603 <div id="footer-text">
604 Last updated 2010-11-06 00:41:57 UTC
605 </div>
606 </div>
607 </body>
608 </html>