Sixth batch
[git/git.git] / Documentation / git-multi-pack-index.txt
CommitLineData
6a257f03
DS
1git-multi-pack-index(1)
2=======================
3
4NAME
5----
6git-multi-pack-index - Write and verify multi-pack-indexes
7
8
9SYNOPSIS
10--------
11[verse]
81efa161 12'git multi-pack-index' [--object-dir=<dir>] <subcommand>
6a257f03
DS
13
14DESCRIPTION
15-----------
16Write or verify a multi-pack-index (MIDX) file.
17
18OPTIONS
19-------
20
21--object-dir=<dir>::
22 Use given directory for the location of Git objects. We check
23 `<dir>/packs/multi-pack-index` for the current MIDX file, and
24 `<dir>/packs` for the pack-files to index.
25
81efa161
DS
26The following subcommands are available:
27
a3407730 28write::
81efa161 29 Write a new MIDX file.
a3407730 30
56ee7ff1 31verify::
81efa161 32 Verify the contents of the MIDX file.
56ee7ff1 33
cff97116
DS
34expire::
35 Delete the pack-files that are tracked by the MIDX file, but
36 have no objects referenced by the MIDX. Rewrite the MIDX file
37 afterward to remove all references to these pack-files.
38
2af890bb
DS
39repack::
40 Create a new pack-file containing objects in small pack-files
41 referenced by the multi-pack-index. If the size given by the
42 `--batch-size=<size>` argument is zero, then create a pack
43 containing all objects referenced by the multi-pack-index. For
44 a non-zero batch size, Select the pack-files by examining packs
45 from oldest-to-newest, computing the "expected size" by counting
46 the number of objects in the pack referenced by the
47 multi-pack-index, then divide by the total number of objects in
48 the pack and multiply by the pack size. We select packs with
49 expected size below the batch size until the set of packs have
50 total expected size at least the batch size. If the total size
51 does not reach the batch size, then do nothing. If a new pack-
52 file is created, rewrite the multi-pack-index to reference the
53 new pack-file. A later run of 'git multi-pack-index expire' will
54 delete the pack-files that were part of this batch.
55
a3407730
DS
56
57EXAMPLES
58--------
59
60* Write a MIDX file for the packfiles in the current .git folder.
61+
62-----------------------------------------------
63$ git multi-pack-index write
64-----------------------------------------------
65
66* Write a MIDX file for the packfiles in an alternate object store.
67+
68-----------------------------------------------
69$ git multi-pack-index --object-dir <alt> write
70-----------------------------------------------
71
56ee7ff1
DS
72* Verify the MIDX file for the packfiles in the current .git folder.
73+
74-----------------------------------------------
75$ git multi-pack-index verify
76-----------------------------------------------
77
6a257f03
DS
78
79SEE ALSO
80--------
81See link:technical/multi-pack-index.html[The Multi-Pack-Index Design
82Document] and link:technical/pack-format.html[The Multi-Pack-Index
83Format] for more information on the multi-pack-index feature.
84
85
86GIT
87---
88Part of the linkgit:git[1] suite