Documentation/git-pack-objects.txt

   1 git-pack-objects(1)
   2 ===================
   3
   4 NAME
   5 ----
   6 git-pack-objects - Create a packed archive of objects
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git pack-objects' [-q | --progress | --all-progress] [--all-progress-implied]
  13         [--no-reuse-delta] [--delta-base-offset] [--non-empty]
  14         [--local] [--incremental] [--window=<n>] [--depth=<n>]
  15         [--revs [--unpacked | --all]] [--stdout | base-name]
  16         [--keep-true-parents] < object-list
  17
  18
  19 DESCRIPTION
  20 -----------
  21 Reads list of objects from the standard input, and writes a packed
  22 archive with specified base-name, or to the standard output.
  23
  24 A packed archive is an efficient way to transfer a set of objects
  25 between two repositories as well as an access efficient archival
  26 format.  In a packed archive, an object is either stored as a
  27 compressed whole or as a difference from some other object.
  28 The latter is often called a delta.
  29
  30 The packed archive format (.pack) is designed to be self-contained
  31 so that it can be unpacked without any further information. Therefore,
  32 each object that a delta depends upon must be present within the pack.
  33
  34 A pack index file (.idx) is generated for fast, random access to the
  35 objects in the pack. Placing both the index file (.idx) and the packed
  36 archive (.pack) in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
  37 any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
  38 enables Git to read from the pack archive.
  39
  40 The 'git unpack-objects' command can read the packed archive and
  41 expand the objects contained in the pack into "one-file
  42 one-object" format; this is typically done by the smart-pull
  43 commands when a pack is created on-the-fly for efficient network
  44 transport by their peers.
  45
  46
  47 OPTIONS
  48 -------
  49 base-name::
  50         Write into a pair of files (.pack and .idx), using
  51         <base-name> to determine the name of the created file.
  52         When this option is used, the two files are written in
  53         <base-name>-<SHA-1>.{pack,idx} files.  <SHA-1> is a hash
  54         based on the pack content and is written to the standard
  55         output of the command.
  56
  57 --stdout::
  58         Write the pack contents (what would have been written to
  59         .pack file) out to the standard output.
  60
  61 --revs::
  62         Read the revision arguments from the standard input, instead of
  63         individual object names.  The revision arguments are processed
  64         the same way as 'git rev-list' with the `--objects` flag
  65         uses its `commit` arguments to build the list of objects it
  66         outputs.  The objects on the resulting list are packed.
  67
  68 --unpacked::
  69         This implies `--revs`.  When processing the list of
  70         revision arguments read from the standard input, limit
  71         the objects packed to those that are not already packed.
  72
  73 --all::
  74         This implies `--revs`.  In addition to the list of
  75         revision arguments read from the standard input, pretend
  76         as if all refs under `refs/` are specified to be
  77         included.
  78
  79 --include-tag::
  80         Include unasked-for annotated tags if the object they
  81         reference was included in the resulting packfile.  This
  82         can be useful to send new tags to native Git clients.
  83
  84 --window=<n>::
  85 --depth=<n>::
  86         These two options affect how the objects contained in
  87         the pack are stored using delta compression.  The
  88         objects are first internally sorted by type, size and
  89         optionally names and compared against the other objects
  90         within --window to see if using delta compression saves
  91         space.  --depth limits the maximum delta depth; making
  92         it too deep affects the performance on the unpacker
  93         side, because delta data needs to be applied that many
  94         times to get to the necessary object.
  95         The default value for --window is 10 and --depth is 50.
  96
  97 --window-memory=<n>::
  98         This option provides an additional limit on top of `--window`;
  99         the window size will dynamically scale down so as to not take
 100         up more than '<n>' bytes in memory.  This is useful in
 101         repositories with a mix of large and small objects to not run
 102         out of memory with a large window, but still be able to take
 103         advantage of the large window for the smaller objects.  The
 104         size can be suffixed with "k", "m", or "g".
 105         `--window-memory=0` makes memory usage unlimited, which is the
 106         default.
 107
 108 --max-pack-size=<n>::
 109         Maximum size of each output pack file. The size can be suffixed with
 110         "k", "m", or "g". The minimum size allowed is limited to 1 MiB.
 111         If specified,  multiple packfiles may be created.
 112         The default is unlimited, unless the config variable
 113         `pack.packSizeLimit` is set.
 114
 115 --honor-pack-keep::
 116         This flag causes an object already in a local pack that
 117         has a .keep file to be ignored, even if it would have
 118         otherwise been packed.
 119
 120 --incremental::
 121         This flag causes an object already in a pack to be ignored
 122         even if it would have otherwise been packed.
 123
 124 --local::
 125         This flag causes an object that is borrowed from an alternate
 126         object store to be ignored even if it would have otherwise been
 127         packed.
 128
 129 --non-empty::
 130         Only create a packed archive if it would contain at
 131         least one object.
 132
 133 --progress::
 134         Progress status is reported on the standard error stream
 135         by default when it is attached to a terminal, unless -q
 136         is specified. This flag forces progress status even if
 137         the standard error stream is not directed to a terminal.
 138
 139 --all-progress::
 140         When --stdout is specified then progress report is
 141         displayed during the object count and compression phases
 142         but inhibited during the write-out phase. The reason is
 143         that in some cases the output stream is directly linked
 144         to another command which may wish to display progress
 145         status of its own as it processes incoming pack data.
 146         This flag is like --progress except that it forces progress
 147         report for the write-out phase as well even if --stdout is
 148         used.
 149
 150 --all-progress-implied::
 151         This is used to imply --all-progress whenever progress display
 152         is activated.  Unlike --all-progress this flag doesn't actually
 153         force any progress display by itself.
 154
 155 -q::
 156         This flag makes the command not to report its progress
 157         on the standard error stream.
 158
 159 --no-reuse-delta::
 160         When creating a packed archive in a repository that
 161         has existing packs, the command reuses existing deltas.
 162         This sometimes results in a slightly suboptimal pack.
 163         This flag tells the command not to reuse existing deltas
 164         but compute them from scratch.
 165
 166 --no-reuse-object::
 167         This flag tells the command not to reuse existing object data at all,
 168         including non deltified object, forcing recompression of everything.
 169         This implies --no-reuse-delta. Useful only in the obscure case where
 170         wholesale enforcement of a different compression level on the
 171         packed data is desired.
 172
 173 --compression=<n>::
 174         Specifies compression level for newly-compressed data in the
 175         generated pack.  If not specified,  pack compression level is
 176         determined first by pack.compression,  then by core.compression,
 177         and defaults to -1,  the zlib default,  if neither is set.
 178         Add --no-reuse-object if you want to force a uniform compression
 179         level on all data no matter the source.
 180
 181 --thin::
 182         Create a "thin" pack by omitting the common objects between a
 183         sender and a receiver in order to reduce network transfer. This
 184         option only makes sense in conjunction with --stdout.
 185 +
 186 Note: A thin pack violates the packed archive format by omitting
 187 required objects and is thus unusable by Git without making it
 188 self-contained. Use `git index-pack --fix-thin`
 189 (see linkgit:git-index-pack[1]) to restore the self-contained property.
 190
 191 --delta-base-offset::
 192         A packed archive can express the base object of a delta as
 193         either a 20-byte object name or as an offset in the
 194         stream, but ancient versions of Git don't understand the
 195         latter.  By default, 'git pack-objects' only uses the
 196         former format for better compatibility.  This option
 197         allows the command to use the latter format for
 198         compactness.  Depending on the average delta chain
 199         length, this option typically shrinks the resulting
 200         packfile by 3-5 per-cent.
 201 +
 202 Note: Porcelain commands such as `git gc` (see linkgit:git-gc[1]),
 203 `git repack` (see linkgit:git-repack[1]) pass this option by default
 204 in modern Git when they put objects in your repository into pack files.
 205 So does `git bundle` (see linkgit:git-bundle[1]) when it creates a bundle.
 206
 207 --threads=<n>::
 208         Specifies the number of threads to spawn when searching for best
 209         delta matches.  This requires that pack-objects be compiled with
 210         pthreads otherwise this option is ignored with a warning.
 211         This is meant to reduce packing time on multiprocessor machines.
 212         The required amount of memory for the delta search window is
 213         however multiplied by the number of threads.
 214         Specifying 0 will cause Git to auto-detect the number of CPU's
 215         and set the number of threads accordingly.
 216
 217 --index-version=<version>[,<offset>]::
 218         This is intended to be used by the test suite only. It allows
 219         to force the version for the generated pack index, and to force
 220         64-bit index entries on objects located above the given offset.
 221
 222 --keep-true-parents::
 223         With this option, parents that are hidden by grafts are packed
 224         nevertheless.
 225
 226 SEE ALSO
 227 --------
 228 linkgit:git-rev-list[1]
 229 linkgit:git-repack[1]
 230 linkgit:git-prune-packed[1]
 231
 232 GIT
 233 ---
 234 Part of the linkgit:git[1] suite