man1/git-index-pack.1

   1 '\" t
   2 .\"     Title: git-index-pack
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-01-30
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.43.0.493.gbc7ee2e5e1
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-INDEX\-PACK" "1" "2024\-01\-30" "Git 2\&.43\&.0\&.493\&.gbc7ee2" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-index-pack \- Build pack index file for an existing packed archive
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit index\-pack\fR [\-v] [\-o <index\-file>] [\-\-[no\-]rev\-index] <pack\-file>
  36 \fIgit index\-pack\fR \-\-stdin [\-\-fix\-thin] [\-\-keep] [\-v] [\-o <index\-file>]
  37                   [\-\-[no\-]rev\-index] [<pack\-file>]
  38 .fi
  39 .sp
  40 .SH "DESCRIPTION"
  41 .sp
  42 Reads a packed archive (\&.pack) from the specified file, builds a pack index file (\&.idx) for it, and optionally writes a reverse\-index (\&.rev) for the specified pack\&. The packed archive, together with the pack index, can then be placed in the objects/pack/ directory of a Git repository\&.
  43 .SH "OPTIONS"
  44 .PP
  45 \-v
  46 .RS 4
  47 Be verbose about what is going on, including progress status\&.
  48 .RE
  49 .PP
  50 \-o <index\-file>
  51 .RS 4
  52 Write the generated pack index into the specified file\&. Without this option the name of pack index file is constructed from the name of packed archive file by replacing \&.pack with \&.idx (and the program fails if the name of packed archive does not end with \&.pack)\&.
  53 .RE
  54 .PP
  55 \-\-[no\-]rev\-index
  56 .RS 4
  57 When this flag is provided, generate a reverse index (a
  58 \fB\&.rev\fR
  59 file) corresponding to the given pack\&. If
  60 \fB\-\-verify\fR
  61 is given, ensure that the existing reverse index is correct\&. Takes precedence over
  62 \fBpack\&.writeReverseIndex\fR\&.
  63 .RE
  64 .PP
  65 \-\-stdin
  66 .RS 4
  67 When this flag is provided, the pack is read from stdin instead and a copy is then written to <pack\-file>\&. If <pack\-file> is not specified, the pack is written to objects/pack/ directory of the current Git repository with a default name determined from the pack content\&. If <pack\-file> is not specified consider using \-\-keep to prevent a race condition between this process and
  68 \fIgit repack\fR\&.
  69 .RE
  70 .PP
  71 \-\-fix\-thin
  72 .RS 4
  73 Fix a "thin" pack produced by
  74 \fBgit pack\-objects \-\-thin\fR
  75 (see
  76 \fBgit-pack-objects\fR(1)
  77 for details) by adding the excluded objects the deltified objects are based on to the pack\&. This option only makes sense in conjunction with \-\-stdin\&.
  78 .RE
  79 .PP
  80 \-\-keep
  81 .RS 4
  82 Before moving the index into its final destination create an empty \&.keep file for the associated pack file\&. This option is usually necessary with \-\-stdin to prevent a simultaneous
  83 \fIgit repack\fR
  84 process from deleting the newly constructed pack and index before refs can be updated to use objects contained in the pack\&.
  85 .RE
  86 .PP
  87 \-\-keep=<msg>
  88 .RS 4
  89 Like \-\-keep, create a \&.keep file before moving the index into its final destination\&. However, instead of creating an empty file place
  90 \fI<msg>\fR
  91 followed by an LF into the \&.keep file\&. The
  92 \fI<msg>\fR
  93 message can later be searched for within all \&.keep files to locate any which have outlived their usefulness\&.
  94 .RE
  95 .PP
  96 \-\-index\-version=<version>[,<offset>]
  97 .RS 4
  98 This is intended to be used by the test suite only\&. It allows to force the version for the generated pack index, and to force 64\-bit index entries on objects located above the given offset\&.
  99 .RE
 100 .PP
 101 \-\-strict
 102 .RS 4
 103 Die, if the pack contains broken objects or links\&.
 104 .RE
 105 .PP
 106 \-\-progress\-title
 107 .RS 4
 108 For internal use only\&.
 109 .sp
 110 Set the title of the progress bar\&. The title is "Receiving objects" by default and "Indexing objects" when
 111 \fB\-\-stdin\fR
 112 is specified\&.
 113 .RE
 114 .PP
 115 \-\-check\-self\-contained\-and\-connected
 116 .RS 4
 117 Die if the pack contains broken links\&. For internal use only\&.
 118 .RE
 119 .PP
 120 \-\-fsck\-objects
 121 .RS 4
 122 For internal use only\&.
 123 .sp
 124 Die if the pack contains broken objects\&. If the pack contains a tree pointing to a \&.gitmodules blob that does not exist, prints the hash of that blob (for the caller to check) after the hash that goes into the name of the pack/idx file (see "Notes")\&.
 125 .RE
 126 .PP
 127 \-\-threads=<n>
 128 .RS 4
 129 Specifies the number of threads to spawn when resolving deltas\&. This requires that index\-pack be compiled with pthreads otherwise this option is ignored with a warning\&. This is meant to reduce packing time on multiprocessor machines\&. The required amount of memory for the delta search window is however multiplied by the number of threads\&. Specifying 0 will cause Git to auto\-detect the number of CPU\(cqs and use maximum 3 threads\&.
 130 .RE
 131 .PP
 132 \-\-max\-input\-size=<size>
 133 .RS 4
 134 Die, if the pack is larger than <size>\&.
 135 .RE
 136 .PP
 137 \-\-object\-format=<hash\-algorithm>
 138 .RS 4
 139 Specify the given object format (hash algorithm) for the pack\&. The valid values are
 140 \fIsha1\fR
 141 and (if enabled)
 142 \fIsha256\fR\&. The default is the algorithm for the current repository (set by
 143 \fBextensions\&.objectFormat\fR), or
 144 \fIsha1\fR
 145 if no value is set or outside a repository\&.
 146 .sp
 147 This option cannot be used with \-\-stdin\&.
 148 .sp
 149 Note: At present, there is no interoperability between SHA\-256 repositories and SHA\-1 repositories\&.
 150 .RE
 151 .sp
 152 Historically, we warned that SHA\-256 repositories may later need backward incompatible changes when we introduce such interoperability features\&. Today, we only expect compatible changes\&. Furthermore, if such changes prove to be necessary, it can be expected that SHA\-256 repositories created with today\(cqs Git will be usable by future versions of Git without data loss\&.
 153 .PP
 154 \-\-promisor[=<message>]
 155 .RS 4
 156 Before committing the pack\-index, create a \&.promisor file for this pack\&. Particularly helpful when writing a promisor pack with \-\-fix\-thin since the name of the pack is not final until the pack has been fully written\&. If a
 157 \fB<message>\fR
 158 is provided, then that content will be written to the \&.promisor file for future reference\&. See
 159 \m[blue]\fBpartial clone\fR\m[]\&\s-2\u[1]\d\s+2
 160 for more information\&.
 161 .RE
 162 .SH "NOTES"
 163 .sp
 164 Once the index has been created, the hash that goes into the name of the pack/idx file is printed to stdout\&. If \-\-stdin was also used then this is prefixed by either "pack\et", or "keep\et" if a new \&.keep file was successfully created\&. This is useful to remove a \&.keep file used as a lock to prevent the race with \fIgit repack\fR mentioned above\&.
 165 .SH "GIT"
 166 .sp
 167 Part of the \fBgit\fR(1) suite
 168 .SH "NOTES"
 169 .IP " 1." 4
 170 partial clone
 171 .RS 4
 172 \%git-htmldocs/technical/partial-clone.html
 173 .RE