Merge branch 'jc/branch-parseopt-fix'
[git/debian.git] / Documentation / git-multi-pack-index.txt
blob3696506eb355e1b11a447a7014dcca370b760555
1 git-multi-pack-index(1)
2 =======================
4 NAME
5 ----
6 git-multi-pack-index - Write and verify multi-pack-indexes
9 SYNOPSIS
10 --------
11 [verse]
12 'git multi-pack-index' [--object-dir=<dir>] [--[no-]bitmap] <sub-command>
14 DESCRIPTION
15 -----------
16 Write or verify a multi-pack-index (MIDX) file.
18 OPTIONS
19 -------
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.
26 `<dir>` must be an alternate of the current repository.
28 --[no-]progress::
29         Turn progress on/off explicitly. If neither is specified, progress is
30         shown if standard error is connected to a terminal. Supported by
31         sub-commands `write`, `verify`, `expire`, and `repack.
33 The following subcommands are available:
35 write::
36         Write a new MIDX file. The following options are available for
37         the `write` sub-command:
40         --preferred-pack=<pack>::
41                 Optionally specify the tie-breaking pack used when
42                 multiple packs contain the same object. `<pack>` must
43                 contain at least one object. If not given, ties are
44                 broken in favor of the pack with the lowest mtime.
46         --[no-]bitmap::
47                 Control whether or not a multi-pack bitmap is written.
49         --stdin-packs::
50                 Write a multi-pack index containing only the set of
51                 line-delimited pack index basenames provided over stdin.
53         --refs-snapshot=<path>::
54                 With `--bitmap`, optionally specify a file which
55                 contains a "refs snapshot" taken prior to repacking.
57 A reference snapshot is composed of line-delimited OIDs corresponding to
58 the reference tips, usually taken by `git repack` prior to generating a
59 new pack. A line may optionally start with a `+` character to indicate
60 that the reference which corresponds to that OID is "preferred" (see
61 linkgit:git-config[1]'s `pack.preferBitmapTips`.)
63 The file given at `<path>` is expected to be readable, and can contain
64 duplicates. (If a given OID is given more than once, it is marked as
65 preferred if at least one instance of it begins with the special `+`
66 marker).
69 verify::
70         Verify the contents of the MIDX file.
72 expire::
73         Delete the pack-files that are tracked by the MIDX file, but
74         have no objects referenced by the MIDX (with the exception of
75         `.keep` packs and cruft packs). Rewrite the MIDX file afterward
76         to remove all references to these pack-files.
78 repack::
79         Create a new pack-file containing objects in small pack-files
80         referenced by the multi-pack-index. If the size given by the
81         `--batch-size=<size>` argument is zero, then create a pack
82         containing all objects referenced by the multi-pack-index. For
83         a non-zero batch size, Select the pack-files by examining packs
84         from oldest-to-newest, computing the "expected size" by counting
85         the number of objects in the pack referenced by the
86         multi-pack-index, then divide by the total number of objects in
87         the pack and multiply by the pack size. We select packs with
88         expected size below the batch size until the set of packs have
89         total expected size at least the batch size, or all pack-files
90         are considered. If only one pack-file is selected, then do
91         nothing. If a new pack-file is created, rewrite the
92         multi-pack-index to reference the new pack-file. A later run of
93         'git multi-pack-index expire' will delete the pack-files that
94         were part of this batch.
96 If `repack.packKeptObjects` is `false`, then any pack-files with an
97 associated `.keep` file will not be selected for the batch to repack.
100 EXAMPLES
101 --------
103 * Write a MIDX file for the packfiles in the current `.git` directory.
105 -----------------------------------------------
106 $ git multi-pack-index write
107 -----------------------------------------------
109 * Write a MIDX file for the packfiles in the current `.git` directory with a
110 corresponding bitmap.
112 -------------------------------------------------------------
113 $ git multi-pack-index write --preferred-pack=<pack> --bitmap
114 -------------------------------------------------------------
116 * Write a MIDX file for the packfiles in an alternate object store.
118 -----------------------------------------------
119 $ git multi-pack-index --object-dir <alt> write
120 -----------------------------------------------
122 * Verify the MIDX file for the packfiles in the current `.git` directory.
124 -----------------------------------------------
125 $ git multi-pack-index verify
126 -----------------------------------------------
129 SEE ALSO
130 --------
131 See link:technical/multi-pack-index.html[The Multi-Pack-Index Design
132 Document] and linkgit:gitformat-pack[5] for more information on the
133 multi-pack-index feature and its file format.
138 Part of the linkgit:git[1] suite