Autogenerated HTML docs for v1.7.7-rc2-4-g5ec82
[git/jnareb-git.git] / git-repack.html
blob688b5a29f05db22d6b3e37c1068c30fb9721179a
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-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.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-repack(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-repack -
578 Pack unpacked objects in a 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 repack</em> [-a] [-A] [-d] [-f] [-F] [-l] [-n] [-q] [--window=&lt;n&gt;] [--depth=&lt;n&gt;]</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>This script is used to combine all objects that do not currently
593 reside in a "pack", into a pack. It can also be used to re-organize
594 existing packs into a single, more efficient pack.</p></div>
595 <div class="paragraph"><p>A pack is a collection of objects, individually compressed, with
596 delta compression applied, stored in a single file, with an
597 associated index file.</p></div>
598 <div class="paragraph"><p>Packs are used to reduce the load on mirror systems, backup
599 engines, disk storage, etc.</p></div>
600 </div>
601 <h2 id="_options">OPTIONS</h2>
602 <div class="sectionbody">
603 <div class="dlist"><dl>
604 <dt class="hdlist1">
606 </dt>
607 <dd>
609 Instead of incrementally packing the unpacked objects,
610 pack everything referenced into a single pack.
611 Especially useful when packing a repository that is used
612 for private development. Use
613 with <em>-d</em>. This will clean up the objects that <tt>git prune</tt>
614 leaves behind, but <tt>git fsck --full</tt> shows as
615 dangling.
616 </p>
617 <div class="paragraph"><p>Note that users fetching over dumb protocols will have to fetch the
618 whole new pack in order to get any contained object, no matter how many
619 other objects in that pack they already have locally.</p></div>
620 </dd>
621 <dt class="hdlist1">
623 </dt>
624 <dd>
626 Same as <tt>-a</tt>, unless <em>-d</em> is used. Then any unreachable
627 objects in a previous pack become loose, unpacked objects,
628 instead of being left in the old pack. Unreachable objects
629 are never intentionally added to a pack, even when repacking.
630 This option prevents unreachable objects from being immediately
631 deleted by way of being left in the old pack and then
632 removed. Instead, the loose unreachable objects
633 will be pruned according to normal expiry rules
634 with the next <em>git gc</em> invocation. See <a href="git-gc.html">git-gc(1)</a>.
635 </p>
636 </dd>
637 <dt class="hdlist1">
639 </dt>
640 <dd>
642 After packing, if the newly created packs make some
643 existing packs redundant, remove the redundant packs.
644 Also run <em>git prune-packed</em> to remove redundant
645 loose object files.
646 </p>
647 </dd>
648 <dt class="hdlist1">
650 </dt>
651 <dd>
653 Pass the <tt>--local</tt> option to <em>git pack-objects</em>. See
654 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
655 </p>
656 </dd>
657 <dt class="hdlist1">
659 </dt>
660 <dd>
662 Pass the <tt>--no-reuse-delta</tt> option to <tt>git-pack-objects</tt>, see
663 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
664 </p>
665 </dd>
666 <dt class="hdlist1">
668 </dt>
669 <dd>
671 Pass the <tt>--no-reuse-object</tt> option to <tt>git-pack-objects</tt>, see
672 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
673 </p>
674 </dd>
675 <dt class="hdlist1">
677 </dt>
678 <dd>
680 Pass the <tt>-q</tt> option to <em>git pack-objects</em>. See
681 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
682 </p>
683 </dd>
684 <dt class="hdlist1">
686 </dt>
687 <dd>
689 Do not update the server information with
690 <em>git update-server-info</em>. This option skips
691 updating local catalog files needed to publish
692 this repository (or a direct copy of it)
693 over HTTP or FTP. See <a href="git-update-server-info.html">git-update-server-info(1)</a>.
694 </p>
695 </dd>
696 <dt class="hdlist1">
697 --window=&lt;n&gt;
698 </dt>
699 <dt class="hdlist1">
700 --depth=&lt;n&gt;
701 </dt>
702 <dd>
704 These two options affect how the objects contained in the pack are
705 stored using delta compression. The objects are first internally
706 sorted by type, size and optionally names and compared against the
707 other objects within <tt>--window</tt> to see if using delta compression saves
708 space. <tt>--depth</tt> limits the maximum delta depth; making it too deep
709 affects the performance on the unpacker side, because delta data needs
710 to be applied that many times to get to the necessary object.
711 The default value for --window is 10 and --depth is 50.
712 </p>
713 </dd>
714 <dt class="hdlist1">
715 --window-memory=&lt;n&gt;
716 </dt>
717 <dd>
719 This option provides an additional limit on top of <tt>--window</tt>;
720 the window size will dynamically scale down so as to not take
721 up more than <em>&lt;n&gt;</em> bytes in memory. This is useful in
722 repositories with a mix of large and small objects to not run
723 out of memory with a large window, but still be able to take
724 advantage of the large window for the smaller objects. The
725 size can be suffixed with "k", "m", or "g".
726 <tt>--window-memory=0</tt> makes memory usage unlimited, which is the
727 default.
728 </p>
729 </dd>
730 <dt class="hdlist1">
731 --max-pack-size=&lt;n&gt;
732 </dt>
733 <dd>
735 Maximum size of each output pack file. The size can be suffixed with
736 "k", "m", or "g". The minimum size allowed is limited to 1 MiB.
737 If specified, multiple packfiles may be created.
738 The default is unlimited, unless the config variable
739 <tt>pack.packSizeLimit</tt> is set.
740 </p>
741 </dd>
742 </dl></div>
743 </div>
744 <h2 id="_configuration">Configuration</h2>
745 <div class="sectionbody">
746 <div class="paragraph"><p>By default, the command passes <tt>--delta-base-offset</tt> option to
747 <em>git pack-objects</em>; this typically results in slightly smaller packs,
748 but the generated packs are incompatible with versions of Git older than
749 version 1.4.4. If you need to share your repository with such ancient Git
750 versions, either directly or via the dumb http or rsync protocol, then you
751 need to set the configuration variable <tt>repack.UseDeltaBaseOffset</tt> to
752 "false" and repack. Access from old Git versions over the native protocol
753 is unaffected by this option as the conversion is performed on the fly
754 as needed in that case.</p></div>
755 </div>
756 <h2 id="_see_also">SEE ALSO</h2>
757 <div class="sectionbody">
758 <div class="paragraph"><p><a href="git-pack-objects.html">git-pack-objects(1)</a>
759 <a href="git-prune-packed.html">git-prune-packed(1)</a></p></div>
760 </div>
761 <h2 id="_git">GIT</h2>
762 <div class="sectionbody">
763 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
764 </div>
765 </div>
766 <div id="footnotes"><hr /></div>
767 <div id="footer">
768 <div id="footer-text">
769 Last updated 2011-09-21 23:01:14 PDT
770 </div>
771 </div>
772 </body>
773 </html>