Google Git
Sign in
chromium / external / gitster / git-htmldocs / 46a38aa8be7b8f7b5afdeeea0744859b3e03d5a2 / . / git-index-pack.html
blob: 93e3f867634ecfba06890aeff5ce87e92d42c109 [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-index-pack(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-index-pack(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-index-pack -
317 Build pack index file for an existing packed archive
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanoa9b8d242007-05-19 04:51:55[diff] [blame]323<div class="verseblock">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]324<div class="content"><em>git index-pack</em> [-v] [-o &lt;index-file&gt;] &lt;pack-file&gt;
325<em>git index-pack</em> --stdin [--fix-thin] [--keep] [-v] [-o &lt;index-file&gt;]
Junio C Hamanoa9b8d242007-05-19 04:51:55[diff] [blame]326 [&lt;pack-file&gt;]</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]327</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]328<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]329<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]330<div class="para"><p>Reads a packed archive (.pack) from the specified file, and
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]331builds a pack index file (.idx) for it. The packed archive
332together with the pack index can then be placed in the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]333objects/pack/ directory of a git repository.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]334</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]335<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]336<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]337<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]338<dt>
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]339-v
340</dt>
341<dd>
342<p>
343 Be verbose about what is going on, including progress status.
344</p>
345</dd>
346<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]347-o &lt;index-file&gt;
348</dt>
349<dd>
350<p>
351 Write the generated pack index into the specified
352 file. Without this option the name of pack index
353 file is constructed from the name of packed archive
354 file by replacing .pack with .idx (and the program
355 fails if the name of packed archive does not end
356 with .pack).
357</p>
358</dd>
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]359<dt>
360--stdin
361</dt>
362<dd>
363<p>
364 When this flag is provided, the pack is read from stdin
365 instead and a copy is then written to &lt;pack-file&gt;. If
366 &lt;pack-file&gt; is not specified, the pack is written to
367 objects/pack/ directory of the current git repository with
368 a default name determined from the pack content. If
369 &lt;pack-file&gt; is not specified consider using --keep to
370 prevent a race condition between this process and
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]371 <em>git-repack</em>.
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]372</p>
373</dd>
374<dt>
375--fix-thin
376</dt>
377<dd>
378<p>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]379 It is possible for <em>git-pack-objects</em> to build
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]380 "thin" pack, which records objects in deltified form based on
381 objects not included in the pack to reduce network traffic.
382 Those objects are expected to be present on the receiving end
383 and they must be included in the pack for that pack to be self
384 contained and indexable. Without this option any attempt to
385 index a thin pack will fail. This option only makes sense in
386 conjunction with --stdin.
387</p>
388</dd>
389<dt>
390--keep
391</dt>
392<dd>
393<p>
394 Before moving the index into its final destination
395 create an empty .keep file for the associated pack file.
396 This option is usually necessary with --stdin to prevent a
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]397 simultaneous <em>git-repack</em> process from deleting
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]398 the newly constructed pack and index before refs can be
399 updated to use objects contained in the pack.
400</p>
401</dd>
402<dt>
403--keep=<em>why</em>
404</dt>
405<dd>
406<p>
407 Like --keep create a .keep file before moving the index into
408 its final destination, but rather than creating an empty file
409 place <em>why</em> followed by an LF into the .keep file. The <em>why</em>
410 message can later be searched for within all .keep files to
411 locate any which have outlived their usefulness.
412</p>
413</dd>
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]414<dt>
415--index-version=&lt;version&gt;[,&lt;offset&gt;]
416</dt>
417<dd>
418<p>
419 This is intended to be used by the test suite only. It allows
420 to force the version for the generated pack index, and to force
421 64-bit index entries on objects located above the given offset.
422</p>
423</dd>
Junio C Hamano4f1d8c42008-03-03 02:01:16[diff] [blame]424<dt>
425--strict
426</dt>
427<dd>
428<p>
429 Die, if the pack contains broken objects or links.
430</p>
431</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]433</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]434<h2 id="_note">Note</h2>
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]435<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]436<div class="para"><p>Once the index has been created, the list of object names is sorted
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]437and the SHA1 hash of that list is printed to stdout. If --stdin was
438also used then this is prefixed by either "pack\t", or "keep\t" if a
439new .keep file was successfully created. This is useful to remove a
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]440.keep file used as a lock to prevent the race with <em>git-repack</em>
441mentioned above.</p></div>
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]442</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]443<h2 id="_author">Author</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]444<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]445<div class="para"><p>Written by Sergey Vlasov &lt;vsu@altlinux.ru&gt;</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]446</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]447<h2 id="_documentation">Documentation</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]448<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]449<div class="para"><p>Documentation by Sergey Vlasov</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]450</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]451<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]452<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]453<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]454</div>
455<div id="footer">
456<div id="footer-text">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]457Last updated 2008-07-06 05:16:51 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]458</div>
459</div>
460</body>
461</html>