Google Git
Sign in
chromium / external / gitster / git-htmldocs / 5f9a6f09653d6397ddb553c1824279557ba878a7 / . / git-repack.html
blob: 214eaca250f4796a0936171d370df630cbaeef8f [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[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" />
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]83 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]164
165div.attribution {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]214div.olist2 ol {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]306</style>
307<title>git-repack(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-repack(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-repack -
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]317 Pack unpacked objects in a repository
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]323<div class="para"><p><em>git repack</em> [-a] [-A] [-d] [-f] [-l] [-n] [-q] [--window=N] [--depth=N]</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]324</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]326<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]327<div class="para"><p>This script is used to combine all objects that do not currently
Junio C Hamanoa6387422007-08-25 03:54:27[diff] [blame]328reside in a "pack", into a pack. It can also be used to re-organize
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]329existing packs into a single, more efficient pack.</p></div>
330<div class="para"><p>A pack is a collection of objects, individually compressed, with
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]331delta compression applied, stored in a single file, with an
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]332associated index file.</p></div>
333<div class="para"><p>Packs are used to reduce the load on mirror systems, backup
334engines, disk storage, etc.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]335</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]336<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]337<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]338<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]339<dt>
340-a
341</dt>
342<dd>
343<p>
344 Instead of incrementally packing the unpacked objects,
Junio C Hamano401939f2007-07-01 06:34:30[diff] [blame]345 pack everything referenced into a single pack.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]346 Especially useful when packing a repository that is used
Junio C Hamano9cb74f22007-02-12 04:15:05[diff] [blame]347 for private development and there is no need to worry
Junio C Hamano401939f2007-07-01 06:34:30[diff] [blame]348 about people fetching via dumb protocols from it. Use
349 with <em>-d</em>. This will clean up the objects that <tt>git prune</tt>
350 leaves behind, but <tt>git fsck --full</tt> shows as
351 dangling.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]352</p>
353</dd>
354<dt>
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]355-A
356</dt>
357<dd>
358<p>
Junio C Hamanobba37ad2008-11-16 17:47:59[diff] [blame]359 Same as <tt>-a</tt>, unless <em>-d</em> is used. Then any unreachable
360 objects in a previous pack become loose, unpacked objects,
361 instead of being left in the old pack. Unreachable objects
362 are never intentionally added to a pack, even when repacking.
363 This option prevents unreachable objects from being immediately
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]364 deleted by way of being left in the old pack and then
365 removed. Instead, the loose unreachable objects
366 will be pruned according to normal expiry rules
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]367 with the next <em>git-gc</em> invocation. See <a href="git-gc.html">git-gc(1)</a>.
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]368</p>
369</dd>
370<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]371-d
372</dt>
373<dd>
374<p>
375 After packing, if the newly created packs make some
376 existing packs redundant, remove the redundant packs.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]377 Also run <em>git-prune-packed</em> to remove redundant
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]378 loose object files.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]379</p>
380</dd>
381<dt>
382-l
383</dt>
384<dd>
385<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]386 Pass the <tt>--local</tt> option to <em>git-pack-objects</em>. See
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]387 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
388</p>
389</dd>
390<dt>
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]391-f
392</dt>
393<dd>
394<p>
Junio C Hamano7cc91292008-09-20 16:55:38[diff] [blame]395 Pass the <tt>--no-reuse-object</tt> option to <tt>git-pack-objects</tt>, see
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]396 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
397</p>
398</dd>
399<dt>
400-q
401</dt>
402<dd>
403<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]404 Pass the <tt>-q</tt> option to <em>git-pack-objects</em>. See
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]405 <a href="git-pack-objects.html">git-pack-objects(1)</a>.
406</p>
407</dd>
408<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]409-n
410</dt>
411<dd>
412<p>
413 Do not update the server information with
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]414 <em>git-update-server-info</em>. This option skips
Junio C Hamanob713ff12008-05-24 01:12:30[diff] [blame]415 updating local catalog files needed to publish
416 this repository (or a direct copy of it)
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]417 over HTTP or FTP. See <a href="git-update-server-info.html">git-update-server-info(1)</a>.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]418</p>
419</dd>
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]420<dt>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]421--window=[N]
422</dt>
423<dt>
424--depth=[N]
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]425</dt>
426<dd>
427<p>
Junio C Hamano93567a62006-10-08 08:47:56[diff] [blame]428 These two options affect how the objects contained in the pack are
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]429 stored using delta compression. The objects are first internally
430 sorted by type, size and optionally names and compared against the
431 other objects within <tt>--window</tt> to see if using delta compression saves
432 space. <tt>--depth</tt> limits the maximum delta depth; making it too deep
433 affects the performance on the unpacker side, because delta data needs
434 to be applied that many times to get to the necessary object.
Junio C Hamano91d44c52007-05-09 07:16:07[diff] [blame]435 The default value for --window is 10 and --depth is 50.
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]436</p>
437</dd>
Junio C Hamano591dc6a2007-05-29 09:18:19[diff] [blame]438<dt>
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]439--window-memory=[N]
440</dt>
441<dd>
442<p>
443 This option provides an additional limit on top of <tt>--window</tt>;
444 the window size will dynamically scale down so as to not take
445 up more than N bytes in memory. This is useful in
446 repositories with a mix of large and small objects to not run
447 out of memory with a large window, but still be able to take
448 advantage of the large window for the smaller objects. The
449 size can be suffixed with "k", "m", or "g".
450 <tt>--window-memory=0</tt> makes memory usage unlimited, which is the
451 default.
452</p>
453</dd>
454<dt>
Junio C Hamano591dc6a2007-05-29 09:18:19[diff] [blame]455--max-pack-size=&lt;n&gt;
456</dt>
457<dd>
458<p>
459 Maximum size of each output packfile, expressed in MiB.
460 If specified, multiple packfiles may be created.
461 The default is unlimited.
462</p>
463</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]464</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]465</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]466<h2 id="_configuration">Configuration</h2>
Junio C Hamano77b7e902006-10-23 07:18:50[diff] [blame]467<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]468<div class="para"><p>When configuration variable <tt>repack.UseDeltaBaseOffset</tt> is set
Junio C Hamano77b7e902006-10-23 07:18:50[diff] [blame]469for the repository, the command passes <tt>--delta-base-offset</tt>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]470option to <em>git-pack-objects</em>; this typically results in slightly
Junio C Hamano77b7e902006-10-23 07:18:50[diff] [blame]471smaller packs, but the generated packs are incompatible with
472versions of git older than (and including) v1.4.3; do not set
473the variable in a repository that older version of git needs to
474be able to read (this includes repositories from which packs can
475be copied out over http or rsync, and people who obtained packs
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]476that way can try to use older git with it).</p></div>
Junio C Hamano77b7e902006-10-23 07:18:50[diff] [blame]477</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]478<h2 id="_author">Author</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]479<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]480<div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]481</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]482<h2 id="_documentation">Documentation</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]483<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]484<div class="para"><p>Documentation by Ryan Anderson &lt;ryan@michonline.com&gt;</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]485</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]486<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]487<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]488<div class="para"><p><a href="git-pack-objects.html">git-pack-objects(1)</a>
489<a href="git-prune-packed.html">git-prune-packed(1)</a></p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]490</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]491<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]492<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]493<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]494</div>
495<div id="footer">
496<div id="footer-text">
Junio C Hamano9572e922009-04-02 06:52:03[diff] [blame]497Last updated 2009-04-02 06:50:01 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]498</div>
499</div>
500</body>
501</html>