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-organize
  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 linkgit:git-prune-packed[1].
  44
  45 -l::
  46         Pass the `--local` option to `git pack-objects`, see
  47         linkgit:git-pack-objects[1].
  48
  49 -f::
  50         Pass the `--no-reuse-delta` option to `git pack-objects`, see
  51         linkgit:git-pack-objects[1].
  52
  53 -q::
  54         Pass the `-q` option to `git pack-objects`, see
  55         linkgit:git-pack-objects[1].
  56
  57 -n::
  58         Do not update the server information with
  59         `git update-server-info`.  This option skips
  60         updating local catalog files needed to publish
  61         this repository (or a direct copy of it)
  62         over HTTP or FTP.  See gitlink:git-update-server-info[1].
  63
  64 --window=[N], --depth=[N]::
  65         These two options affect how the objects contained in the pack are
  66         stored using delta compression. The objects are first internally
  67         sorted by type, size and optionally names and compared against the
  68         other objects within `--window` to see if using delta compression saves
  69         space. `--depth` limits the maximum delta depth; making it too deep
  70         affects the performance on the unpacker side, because delta data needs
  71         to be applied that many times to get to the necessary object.
  72         The default value for --window is 10 and --depth is 50.
  73
  74 --window-memory=[N]::
  75         This option provides an additional limit on top of `--window`;
  76         the window size will dynamically scale down so as to not take
  77         up more than N bytes in memory.  This is useful in
  78         repositories with a mix of large and small objects to not run
  79         out of memory with a large window, but still be able to take
  80         advantage of the large window for the smaller objects.  The
  81         size can be suffixed with "k", "m", or "g".
  82         `--window-memory=0` makes memory usage unlimited, which is the
  83         default.
  84
  85 --max-pack-size=<n>::
  86         Maximum size of each output packfile, expressed in MiB.
  87         If specified,  multiple packfiles may be created.
  88         The default is unlimited.
  89
  90
  91 Configuration
  92 -------------
  93
  94 When configuration variable `repack.UseDeltaBaseOffset` is set
  95 for the repository, the command passes `--delta-base-offset`
  96 option to `git-pack-objects`; this typically results in slightly
  97 smaller packs, but the generated packs are incompatible with
  98 versions of git older than (and including) v1.4.3; do not set
  99 the variable in a repository that older version of git needs to
 100 be able to read (this includes repositories from which packs can
 101 be copied out over http or rsync, and people who obtained packs
 102 that way can try to use older git with it).
 103
 104
 105 Author
 106 ------
 107 Written by Linus Torvalds <torvalds@osdl.org>
 108
 109 Documentation
 110 --------------
 111 Documentation by Ryan Anderson <ryan@michonline.com>
 112
 113 See Also
 114 --------
 115 linkgit:git-pack-objects[1]
 116 linkgit:git-prune-packed[1]
 117
 118 GIT
 119 ---
 120 Part of the linkgit:git[7] suite