]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-multi-pack-index.txt
multi-pack-index: add [--[no-]progress] option.
[thirdparty/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]
680cba2c 12'git multi-pack-index' [--object-dir=<dir>] [--[no-]progress] <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
680cba2c
WB
26--[no-]progress::
27 Turn progress on/off explicitly. If neither is specified, progress is
28 shown if standard error is connected to a terminal.
29
81efa161
DS
30The following subcommands are available:
31
a3407730 32write::
81efa161 33 Write a new MIDX file.
a3407730 34
56ee7ff1 35verify::
81efa161 36 Verify the contents of the MIDX file.
56ee7ff1 37
cff97116
DS
38expire::
39 Delete the pack-files that are tracked by the MIDX file, but
40 have no objects referenced by the MIDX. Rewrite the MIDX file
41 afterward to remove all references to these pack-files.
42
2af890bb
DS
43repack::
44 Create a new pack-file containing objects in small pack-files
45 referenced by the multi-pack-index. If the size given by the
46 `--batch-size=<size>` argument is zero, then create a pack
47 containing all objects referenced by the multi-pack-index. For
48 a non-zero batch size, Select the pack-files by examining packs
49 from oldest-to-newest, computing the "expected size" by counting
50 the number of objects in the pack referenced by the
51 multi-pack-index, then divide by the total number of objects in
52 the pack and multiply by the pack size. We select packs with
53 expected size below the batch size until the set of packs have
54 total expected size at least the batch size. If the total size
55 does not reach the batch size, then do nothing. If a new pack-
56 file is created, rewrite the multi-pack-index to reference the
57 new pack-file. A later run of 'git multi-pack-index expire' will
58 delete the pack-files that were part of this batch.
59
a3407730
DS
60
61EXAMPLES
62--------
63
64* Write a MIDX file for the packfiles in the current .git folder.
65+
66-----------------------------------------------
67$ git multi-pack-index write
68-----------------------------------------------
69
70* Write a MIDX file for the packfiles in an alternate object store.
71+
72-----------------------------------------------
73$ git multi-pack-index --object-dir <alt> write
74-----------------------------------------------
75
56ee7ff1
DS
76* Verify the MIDX file for the packfiles in the current .git folder.
77+
78-----------------------------------------------
79$ git multi-pack-index verify
80-----------------------------------------------
81
6a257f03
DS
82
83SEE ALSO
84--------
85See link:technical/multi-pack-index.html[The Multi-Pack-Index Design
86Document] and link:technical/pack-format.html[The Multi-Pack-Index
87Format] for more information on the multi-pack-index feature.
88
89
90GIT
91---
92Part of the linkgit:git[1] suite