Code

make index-pack able to complete thin packs.
[git.git] / Documentation / git-index-pack.txt
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 'git-index-pack' [-o <index-file>] <pack-file>
12 'git-index-pack' --stdin [--fix-thin] [-o <index-file>] [<pack-file>]
15 DESCRIPTION
16 -----------
17 Reads a packed archive (.pack) from the specified file, and
18 builds a pack index file (.idx) for it.  The packed archive
19 together with the pack index can then be placed in the
20 objects/pack/ directory of a git repository.
23 OPTIONS
24 -------
25 -o <index-file>::
26         Write the generated pack index into the specified
27         file.  Without this option the name of pack index
28         file is constructed from the name of packed archive
29         file by replacing .pack with .idx (and the program
30         fails if the name of packed archive does not end
31         with .pack).
33 --stdin::
34         When this flag is provided, the pack is read from stdin
35         instead and a copy is then written to <pack-file>. If
36         <pack-file> is not specified, the pack is written to
37         objects/pack/ directory of the current git repository with
38         a default name determined from the pack content.
40 --fix-thin::
41         It is possible for gitlink:git-pack-objects[1] to build
42         "thin" pack, which records objects in deltified form based on
43         objects not included in the pack to reduce network traffic.
44         Those objects are expected to be present on the receiving end
45         and they must be included in the pack for that pack to be self
46         contained and indexable. Without this option any attempt to
47         index a thin pack will fail. This option only makes sense in
48         conjonction with --stdin.
51 Author
52 ------
53 Written by Sergey Vlasov <vsu@altlinux.ru>
55 Documentation
56 -------------
57 Documentation by Sergey Vlasov
59 GIT
60 ---
61 Part of the gitlink:git[7] suite