Google Git
Sign in
chromium / external / gitster / git-htmldocs / a3d4ca2ddaca08b3bdb0fdbc4479b954e1e028e5 / . / git-index-pack.html
blob: 0be89609e77c9ced2e6db227b7c4a9c32eac034c [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 Hamano68cf15a2010-11-06 01:01:59[diff] [blame]6<meta name="generator" content="AsciiDoc 8.4.5" />
7<title>git-index-pack(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]30 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]35 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, 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;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]91}
92span#email {
93}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 font-family: sans-serif;
96}
97
98div#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;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
127}
128
129div.content { /* Block element content. */
130 padding: 0;
131}
132
133/* Block element titles. */
134div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]135 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
141}
142div.title + * {
143 margin-top: 0;
144}
145
146td div.title:first-child {
147 margin-top: 0.0em;
148}
149div.content div.title:first-child {
150 margin-top: 0.0em;
151}
152div.content + div.title {
153 margin-top: 0.0em;
154}
155
156div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
160}
161
162div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
166}
167
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]168div.quoteblock {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]169 padding-left: 2.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]170 margin-right: 10%;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]171}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]172div.quoteblock > div.attribution {
173 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]174 text-align: right;
175}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]176
177div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
180}
181div.verseblock > div.content {
182 white-space: pre;
183}
184div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
187}
188/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]189div.verseblock + div.attribution {
190 text-align: left;
191}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]192
193div.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;
200}
201div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
204}
205
206div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
209}
210
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]211div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]212span.image img { border-style: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]213a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]214
215dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
218}
219dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]222 font-style: normal;
223 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]224}
225dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]226 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]227}
228
229ul, ol {
230 list-style-position: outside;
231}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]232ol.arabic {
233 list-style-type: decimal;
234}
235ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]236 list-style-type: lower-alpha;
237}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]238ol.upperalpha {
239 list-style-type: upper-alpha;
240}
241ol.lowerroman {
242 list-style-type: lower-roman;
243}
244ol.upperroman {
245 list-style-type: upper-roman;
246}
247
248div.compact ul, div.compact ol,
249div.compact p, div.compact p,
250div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
253}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]254
255div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]256 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]257}
258thead {
259 font-family: sans-serif;
260 font-weight: bold;
261}
262tfoot {
263 font-weight: bold;
264}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]265td > div.verse {
266 white-space: pre;
267}
268p.table {
269 margin-top: 0;
270}
271/* Because the table frame attribute is overriden by CSS in most browsers. */
272div.tableblock > table[frame="void"] {
273 border-style: none;
274}
275div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
278}
279div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
282}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]283
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]284
285div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
288}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]289div.hdlist tr {
290 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]291}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]292dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
294}
295td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]296 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]297 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]298 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]299 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]300}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]301td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]302 vertical-align: top;
303}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]304div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
307}
308
309.comment {
310 background: yellow;
311}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]312
313@media print {
314 div#footer-badges { display: none; }
315}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]316
317div#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;
324}
325
326div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
329}
330div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
333}
334div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
337}
338div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
341}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]342/* Overrides for manpage documents */
343h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
348}
349h2 {
350 border-style: none;
351}
352div.sectionbody {
353 margin-left: 5%;
354}
355
356@media print {
357 div#toc { display: none; }
358}
359
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]360/* Workarounds for IE6's broken and incomplete CSS2. */
361
362div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
366}
367div.sidebar-title, div.image-title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]368 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
373}
374
375div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
379}
380
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]381div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
384}
385
386div.verseblock-content {
387 white-space: pre;
388}
389div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]392}
393
394div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
397}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]398
399/* IE6 sets dynamically generated links as visited. */
400div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]401</style>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]402</head>
403<body>
404<div id="header">
405<h1>
406git-index-pack(1) Manual Page
407</h1>
408<h2>NAME</h2>
409<div class="sectionbody">
410<p>git-index-pack -
411 Build pack index file for an existing packed archive
412</p>
413</div>
414</div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]415<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]416<div class="sectionbody">
Junio C Hamanoa9b8d242007-05-19 04:51:55[diff] [blame]417<div class="verseblock">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]418<div class="verseblock-content"><em>git index-pack</em> [-v] [-o &lt;index-file&gt;] &lt;pack-file&gt;
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]419<em>git index-pack</em> --stdin [--fix-thin] [--keep] [-v] [-o &lt;index-file&gt;]
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]420 [&lt;pack-file&gt;]</div>
421<div class="verseblock-attribution">
422</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]423</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]424<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]425<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]426<div class="paragraph"><p>Reads a packed archive (.pack) from the specified file, and
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]427builds a pack index file (.idx) for it. The packed archive
428together with the pack index can then be placed in the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]429objects/pack/ directory of a git repository.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]430</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]431<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]432<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]433<div class="dlist"><dl>
434<dt class="hdlist1">
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]435-v
436</dt>
437<dd>
438<p>
439 Be verbose about what is going on, including progress status.
440</p>
441</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]442<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]443-o &lt;index-file&gt;
444</dt>
445<dd>
446<p>
447 Write the generated pack index into the specified
448 file. Without this option the name of pack index
449 file is constructed from the name of packed archive
450 file by replacing .pack with .idx (and the program
451 fails if the name of packed archive does not end
452 with .pack).
453</p>
454</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]455<dt class="hdlist1">
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]456--stdin
457</dt>
458<dd>
459<p>
460 When this flag is provided, the pack is read from stdin
461 instead and a copy is then written to &lt;pack-file&gt;. If
462 &lt;pack-file&gt; is not specified, the pack is written to
463 objects/pack/ directory of the current git repository with
464 a default name determined from the pack content. If
465 &lt;pack-file&gt; is not specified consider using --keep to
466 prevent a race condition between this process and
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]467 <em>git repack</em>.
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]468</p>
469</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]470<dt class="hdlist1">
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]471--fix-thin
472</dt>
473<dd>
474<p>
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]475 Fix a "thin" pack produced by <tt>git pack-objects --thin</tt> (see
476 <a href="git-pack-objects.html">git-pack-objects(1)</a> for details) by adding the
477 excluded objects the deltified objects are based on to the
478 pack. This option only makes sense in conjunction with --stdin.
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]479</p>
480</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]481<dt class="hdlist1">
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]482--keep
483</dt>
484<dd>
485<p>
486 Before moving the index into its final destination
487 create an empty .keep file for the associated pack file.
488 This option is usually necessary with --stdin to prevent a
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]489 simultaneous <em>git repack</em> process from deleting
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]490 the newly constructed pack and index before refs can be
491 updated to use objects contained in the pack.
492</p>
493</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]494<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]495--keep=&lt;msg&gt;
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]496</dt>
497<dd>
498<p>
499 Like --keep create a .keep file before moving the index into
500 its final destination, but rather than creating an empty file
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]501 place <em>&lt;msg&gt;</em> followed by an LF into the .keep file. The <em>&lt;msg&gt;</em>
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]502 message can later be searched for within all .keep files to
503 locate any which have outlived their usefulness.
504</p>
505</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]506<dt class="hdlist1">
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]507--index-version=&lt;version&gt;[,&lt;offset&gt;]
508</dt>
509<dd>
510<p>
511 This is intended to be used by the test suite only. It allows
512 to force the version for the generated pack index, and to force
513 64-bit index entries on objects located above the given offset.
514</p>
515</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]516<dt class="hdlist1">
Junio C Hamano4f1d8c42008-03-03 02:01:16[diff] [blame]517--strict
518</dt>
519<dd>
520<p>
521 Die, if the pack contains broken objects or links.
522</p>
523</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]524</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]525</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]526<h2 id="_note">Note</h2>
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]527<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]528<div class="paragraph"><p>Once the index has been created, the list of object names is sorted
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]529and the SHA1 hash of that list is printed to stdout. If --stdin was
530also used then this is prefixed by either "pack\t", or "keep\t" if a
531new .keep file was successfully created. This is useful to remove a
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]532.keep file used as a lock to prevent the race with <em>git repack</em>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]533mentioned above.</p></div>
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]534</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]535<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]536<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]537<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]538</div>
539<div id="footer">
540<div id="footer-text">
Junio C Hamano5f3d8392011-03-15 23:33:35[diff] [blame]541Last updated 2011-03-15 23:30:13 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]542</div>
543</div>
544</body>
545</html>