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