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>] [--[no-]rev-index] <pack-file>
  13 'git index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>]
  14                   [--[no-]rev-index] [<pack-file>]
  15
  16
  17 DESCRIPTION
  18 -----------
  19 Reads a packed archive (.pack) from the specified file,
  20 builds a pack index file (.idx) for it, and optionally writes a
  21 reverse-index (.rev) for the specified pack. The packed
  22 archive, together with the pack index, can then be placed in
  23 the objects/pack/ directory of a Git repository.
  24
  25
  26 OPTIONS
  27 -------
  28 -v::
  29         Be verbose about what is going on, including progress status.
  30
  31 -o <index-file>::
  32         Write the generated pack index into the specified
  33         file.  Without this option the name of pack index
  34         file is constructed from the name of packed archive
  35         file by replacing .pack with .idx (and the program
  36         fails if the name of packed archive does not end
  37         with .pack).
  38
  39 --[no-]rev-index::
  40         When this flag is provided, generate a reverse index
  41         (a `.rev` file) corresponding to the given pack. If
  42         `--verify` is given, ensure that the existing
  43         reverse index is correct. Takes precedence over
  44         `pack.writeReverseIndex`.
  45
  46 --stdin::
  47         When this flag is provided, the pack is read from stdin
  48         instead and a copy is then written to <pack-file>. If
  49         <pack-file> is not specified, the pack is written to
  50         objects/pack/ directory of the current Git repository with
  51         a default name determined from the pack content.  If
  52         <pack-file> is not specified consider using --keep to
  53         prevent a race condition between this process and
  54         'git repack'.
  55
  56 --fix-thin::
  57         Fix a "thin" pack produced by `git pack-objects --thin` (see
  58         linkgit:git-pack-objects[1] for details) by adding the
  59         excluded objects the deltified objects are based on to the
  60         pack. This option only makes sense in conjunction with --stdin.
  61
  62 --keep::
  63         Before moving the index into its final destination
  64         create an empty .keep file for the associated pack file.
  65         This option is usually necessary with --stdin to prevent a
  66         simultaneous 'git repack' process from deleting
  67         the newly constructed pack and index before refs can be
  68         updated to use objects contained in the pack.
  69
  70 --keep=<msg>::
  71         Like --keep, create a .keep file before moving the index into
  72         its final destination.  However, instead of creating an empty file
  73         place '<msg>' followed by an LF into the .keep file.  The '<msg>'
  74         message can later be searched for within all .keep files to
  75         locate any which have outlived their usefulness.
  76
  77 --index-version=<version>[,<offset>]::
  78         This is intended to be used by the test suite only. It allows
  79         to force the version for the generated pack index, and to force
  80         64-bit index entries on objects located above the given offset.
  81
  82 --strict[=<msg-id>=<severity>...]::
  83         Die, if the pack contains broken objects or links. An optional
  84         comma-separated list of `<msg-id>=<severity>` can be passed to change
  85         the severity of some possible issues, e.g.,
  86          `--strict="missingEmail=ignore,badTagName=error"`. See the entry for the
  87         `fsck.<msg-id>` configuration options in linkgit:git-fsck[1] for more
  88         information on the possible values of `<msg-id>` and `<severity>`.
  89
  90 --progress-title::
  91         For internal use only.
  92 +
  93 Set the title of the progress bar. The title is "Receiving objects" by
  94 default and "Indexing objects" when `--stdin` is specified.
  95
  96 --check-self-contained-and-connected::
  97         Die if the pack contains broken links. For internal use only.
  98
  99 --fsck-objects[=<msg-id>=<severity>...]::
 100         Die if the pack contains broken objects, but unlike `--strict`, don't
 101         choke on broken links. If the pack contains a tree pointing to a
 102         .gitmodules blob that does not exist, prints the hash of that blob
 103         (for the caller to check) after the hash that goes into the name of the
 104         pack/idx file (see "Notes").
 105 +
 106 An optional comma-separated list of `<msg-id>=<severity>` can be passed to
 107 change the severity of some possible issues, e.g.,
 108 `--fsck-objects="missingEmail=ignore,badTagName=ignore"`. See the entry for the
 109 `fsck.<msg-id>` configuration options in linkgit:git-fsck[1] for more
 110 information on the possible values of `<msg-id>` and `<severity>`.
 111
 112 --threads=<n>::
 113         Specifies the number of threads to spawn when resolving
 114         deltas. This requires that index-pack be compiled with
 115         pthreads otherwise this option is ignored with a warning.
 116         This is meant to reduce packing time on multiprocessor
 117         machines. The required amount of memory for the delta search
 118         window is however multiplied by the number of threads.
 119         Specifying 0 will cause Git to auto-detect the number of CPU's
 120         and use maximum 3 threads.
 121
 122 --max-input-size=<size>::
 123         Die, if the pack is larger than <size>.
 124
 125 --object-format=<hash-algorithm>::
 126         Specify the given object format (hash algorithm) for the pack.  The valid
 127         values are 'sha1' and (if enabled) 'sha256'.  The default is the algorithm for
 128         the current repository (set by `extensions.objectFormat`), or 'sha1' if no
 129         value is set or outside a repository.
 130 +
 131 This option cannot be used with --stdin.
 132 +
 133 include::object-format-disclaimer.txt[]
 134
 135 --promisor[=<message>]::
 136         Before committing the pack-index, create a .promisor file for this
 137         pack. Particularly helpful when writing a promisor pack with --fix-thin
 138         since the name of the pack is not final until the pack has been fully
 139         written. If a `<message>` is provided, then that content will be
 140         written to the .promisor file for future reference. See
 141         link:technical/partial-clone.html[partial clone] for more information.
 142 +
 143 Also, if there are objects in the given pack that references non-promisor
 144 objects (in the repo), repacks those non-promisor objects into a promisor
 145 pack. This avoids a situation in which a repo has non-promisor objects that are
 146 accessible through promisor objects.
 147
 148 NOTES
 149 -----
 150
 151 Once the index has been created, the hash that goes into the name of
 152 the pack/idx file is printed to stdout. If --stdin was
 153 also used then this is prefixed by either "pack\t", or "keep\t" if a
 154 new .keep file was successfully created. This is useful to remove a
 155 .keep file used as a lock to prevent the race with 'git repack'
 156 mentioned above.
 157
 158 GIT
 159 ---
 160 Part of the linkgit:git[1] suite