i18n: grep: mark parseopt strings for translation
[git/jnareb-git.git] / Documentation / git-index-pack.txt
blob39e6d0ddd84eeeacf43f41e0807cc1e305089ed0
1 git-index-pack(1)
2 =================
4 NAME
5 ----
6 git-index-pack - Build pack index file for an existing packed archive
9 SYNOPSIS
10 --------
11 [verse]
12 'git index-pack' [-v] [-o <index-file>] <pack-file>
13 'git index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>]
14                  [<pack-file>]
17 DESCRIPTION
18 -----------
19 Reads a packed archive (.pack) from the specified file, and
20 builds a pack index file (.idx) for it.  The packed archive
21 together with the pack index can then be placed in the
22 objects/pack/ directory of a git repository.
25 OPTIONS
26 -------
27 -v::
28         Be verbose about what is going on, including progress status.
30 -o <index-file>::
31         Write the generated pack index into the specified
32         file.  Without this option the name of pack index
33         file is constructed from the name of packed archive
34         file by replacing .pack with .idx (and the program
35         fails if the name of packed archive does not end
36         with .pack).
38 --stdin::
39         When this flag is provided, the pack is read from stdin
40         instead and a copy is then written to <pack-file>. If
41         <pack-file> is not specified, the pack is written to
42         objects/pack/ directory of the current git repository with
43         a default name determined from the pack content.  If
44         <pack-file> is not specified consider using --keep to
45         prevent a race condition between this process and
46         'git repack'.
48 --fix-thin::
49         Fix a "thin" pack produced by `git pack-objects --thin` (see
50         linkgit:git-pack-objects[1] for details) by adding the
51         excluded objects the deltified objects are based on to the
52         pack. This option only makes sense in conjunction with --stdin.
54 --keep::
55         Before moving the index into its final destination
56         create an empty .keep file for the associated pack file.
57         This option is usually necessary with --stdin to prevent a
58         simultaneous 'git repack' process from deleting
59         the newly constructed pack and index before refs can be
60         updated to use objects contained in the pack.
62 --keep=<msg>::
63         Like --keep create a .keep file before moving the index into
64         its final destination, but rather than creating an empty file
65         place '<msg>' followed by an LF into the .keep file.  The '<msg>'
66         message can later be searched for within all .keep files to
67         locate any which have outlived their usefulness.
69 --index-version=<version>[,<offset>]::
70         This is intended to be used by the test suite only. It allows
71         to force the version for the generated pack index, and to force
72         64-bit index entries on objects located above the given offset.
74 --strict::
75         Die, if the pack contains broken objects or links.
77 --threads=<n>::
78         Specifies the number of threads to spawn when resolving
79         deltas. This requires that index-pack be compiled with
80         pthreads otherwise this option is ignored with a warning.
81         This is meant to reduce packing time on multiprocessor
82         machines. The required amount of memory for the delta search
83         window is however multiplied by the number of threads.
84         Specifying 0 will cause git to auto-detect the number of CPU's
85         and use maximum 3 threads.
88 Note
89 ----
91 Once the index has been created, the list of object names is sorted
92 and the SHA1 hash of that list is printed to stdout. If --stdin was
93 also used then this is prefixed by either "pack\t", or "keep\t" if a
94 new .keep file was successfully created. This is useful to remove a
95 .keep file used as a lock to prevent the race with 'git repack'
96 mentioned above.
98 GIT
99 ---
100 Part of the linkgit:git[1] suite