Documentation/git-index-pack.txt

   1 git-index-pack(1)
   2 =================
   3
   4 NAME
   5 ----
   6 git-index-pack - Build pack index file for an existing packed archive
   7
   8
   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>]
  15
  16
  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.
  23
  24
  25 OPTIONS
  26 -------
  27 -v::
  28         Be verbose about what is going on, including progress status.
  29
  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).
  37
  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'.
  47
  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.
  53
  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.
  61
  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.
  68
  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.
  73
  74 --strict::
  75         Die, if the pack contains broken objects or links.
  76
  77 --check-self-contained-and-connected::
  78         Die if the pack contains broken links. For internal use only.
  79
  80 --fsck-objects::
  81         Die if the pack contains broken objects. For internal use only.
  82
  83 --threads=<n>::
  84         Specifies the number of threads to spawn when resolving
  85         deltas. This requires that index-pack be compiled with
  86         pthreads otherwise this option is ignored with a warning.
  87         This is meant to reduce packing time on multiprocessor
  88         machines. The required amount of memory for the delta search
  89         window is however multiplied by the number of threads.
  90         Specifying 0 will cause Git to auto-detect the number of CPU's
  91         and use maximum 3 threads.
  92
  93 --max-input-size=<size>::
  94         Die, if the pack is larger than <size>.
  95
  96 NOTES
  97 -----
  98
  99 Once the index has been created, the list of object names is sorted
 100 and the SHA-1 hash of that list is printed to stdout. If --stdin was
 101 also used then this is prefixed by either "pack\t", or "keep\t" if a
 102 new .keep file was successfully created. This is useful to remove a
 103 .keep file used as a lock to prevent the race with 'git repack'
 104 mentioned above.
 105
 106 GIT
 107 ---
 108 Part of the linkgit:git[1] suite