Documentation/git-repack.txt

   1 git-repack(1)
   2 =============
   3
   4 NAME
   5 ----
   6 git-repack - Pack unpacked objects in a repository
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git-repack' [-a] [-d] [-f] [-l] [-n] [-q] [--window=N] [--depth=N]
  12
  13 DESCRIPTION
  14 -----------
  15
  16 This script is used to combine all objects that do not currently
  17 reside in a "pack", into a pack.  It can also be used to re-organise
  18 existing packs into a single, more efficient pack.
  19
  20 A pack is a collection of objects, individually compressed, with
  21 delta compression applied, stored in a single file, with an
  22 associated index file.
  23
  24 Packs are used to reduce the load on mirror systems, backup
  25 engines, disk storage, etc.
  26
  27 OPTIONS
  28 -------
  29
  30 -a::
  31         Instead of incrementally packing the unpacked objects,
  32         pack everything referenced into a single pack.
  33         Especially useful when packing a repository that is used
  34         for private development and there is no need to worry
  35         about people fetching via dumb protocols from it.  Use
  36         with '-d'.  This will clean up the objects that `git prune`
  37         leaves behind, but `git fsck --full` shows as
  38         dangling.
  39
  40 -d::
  41         After packing, if the newly created packs make some
  42         existing packs redundant, remove the redundant packs.
  43         Also runs gitlink:git-prune-packed[1].
  44
  45 -l::
  46         Pass the `--local` option to `git pack-objects`, see
  47         gitlink:git-pack-objects[1].
  48
  49 -f::
  50         Pass the `--no-reuse-delta` option to `git pack-objects`, see
  51         gitlink:git-pack-objects[1].
  52
  53 -q::
  54         Pass the `-q` option to `git pack-objects`, see
  55         gitlink:git-pack-objects[1].
  56
  57 -n::
  58         Do not update the server information with
  59         `git update-server-info`.
  60
  61 --window=[N], --depth=[N]::
  62         These two options affect how the objects contained in the pack are
  63         stored using delta compression. The objects are first internally
  64         sorted by type, size and optionally names and compared against the
  65         other objects within `--window` to see if using delta compression saves
  66         space. `--depth` limits the maximum delta depth; making it too deep
  67         affects the performance on the unpacker side, because delta data needs
  68         to be applied that many times to get to the necessary object.
  69         The default value for --window is 10 and --depth is 50.
  70
  71 --window-memory=[N]::
  72         This option provides an additional limit on top of `--window`;
  73         the window size will dynamically scale down so as to not take
  74         up more than N bytes in memory.  This is useful in
  75         repositories with a mix of large and small objects to not run
  76         out of memory with a large window, but still be able to take
  77         advantage of the large window for the smaller objects.  The
  78         size can be suffixed with "k", "m", or "g".
  79         `--window-memory=0` makes memory usage unlimited, which is the
  80         default.
  81
  82 --max-pack-size=<n>::
  83         Maximum size of each output packfile, expressed in MiB.
  84         If specified,  multiple packfiles may be created.
  85         The default is unlimited.
  86
  87
  88 Configuration
  89 -------------
  90
  91 When configuration variable `repack.UseDeltaBaseOffset` is set
  92 for the repository, the command passes `--delta-base-offset`
  93 option to `git-pack-objects`; this typically results in slightly
  94 smaller packs, but the generated packs are incompatible with
  95 versions of git older than (and including) v1.4.3; do not set
  96 the variable in a repository that older version of git needs to
  97 be able to read (this includes repositories from which packs can
  98 be copied out over http or rsync, and people who obtained packs
  99 that way can try to use older git with it).
 100
 101
 102 Author
 103 ------
 104 Written by Linus Torvalds <torvalds@osdl.org>
 105
 106 Documentation
 107 --------------
 108 Documentation by Ryan Anderson <ryan@michonline.com>
 109
 110 See Also
 111 --------
 112 gitlink:git-pack-objects[1]
 113 gitlink:git-prune-packed[1]
 114
 115 GIT
 116 ---
 117 Part of the gitlink:git[7] suite