Documentation / git-repack.txton commit Keep together options controlling the behaviour of diffcore-rename. (f103744)
   1git-repack(1)
   2=============
   3
   4NAME
   5----
   6git-repack - Pack unpacked objects in a repository
   7
   8
   9SYNOPSIS
  10--------
  11'git repack' [-a] [-A] [-d] [-f] [-l] [-n] [-q] [--window=<n>] [--depth=<n>]
  12
  13DESCRIPTION
  14-----------
  15
  16This script is used to combine all objects that do not currently
  17reside in a "pack", into a pack.  It can also be used to re-organize
  18existing packs into a single, more efficient pack.
  19
  20A pack is a collection of objects, individually compressed, with
  21delta compression applied, stored in a single file, with an
  22associated index file.
  23
  24Packs are used to reduce the load on mirror systems, backup
  25engines, disk storage, etc.
  26
  27OPTIONS
  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. Use
  35        with '-d'.  This will clean up the objects that `git prune`
  36        leaves behind, but `git fsck --full` shows as
  37        dangling.
  38+
  39Note that users fetching over dumb protocols will have to fetch the
  40whole new pack in order to get any contained object, no matter how many
  41other objects in that pack they already have locally.
  42
  43-A::
  44        Same as `-a`, unless '-d' is used.  Then any unreachable
  45        objects in a previous pack become loose, unpacked objects,
  46        instead of being left in the old pack.  Unreachable objects
  47        are never intentionally added to a pack, even when repacking.
  48        This option prevents unreachable objects from being immediately
  49        deleted by way of being left in the old pack and then
  50        removed.  Instead, the loose unreachable objects
  51        will be pruned according to normal expiry rules
  52        with the next 'git gc' invocation. See linkgit:git-gc[1].
  53
  54-d::
  55        After packing, if the newly created packs make some
  56        existing packs redundant, remove the redundant packs.
  57        Also run  'git prune-packed' to remove redundant
  58        loose object files.
  59
  60-l::
  61        Pass the `--local` option to 'git pack-objects'. See
  62        linkgit:git-pack-objects[1].
  63
  64-f::
  65        Pass the `--no-reuse-object` option to `git-pack-objects`, see
  66        linkgit:git-pack-objects[1].
  67
  68-q::
  69        Pass the `-q` option to 'git pack-objects'. See
  70        linkgit:git-pack-objects[1].
  71
  72-n::
  73        Do not update the server information with
  74        'git update-server-info'.  This option skips
  75        updating local catalog files needed to publish
  76        this repository (or a direct copy of it)
  77        over HTTP or FTP.  See linkgit:git-update-server-info[1].
  78
  79--window=<n>::
  80--depth=<n>::
  81        These two options affect how the objects contained in the pack are
  82        stored using delta compression. The objects are first internally
  83        sorted by type, size and optionally names and compared against the
  84        other objects within `--window` to see if using delta compression saves
  85        space. `--depth` limits the maximum delta depth; making it too deep
  86        affects the performance on the unpacker side, because delta data needs
  87        to be applied that many times to get to the necessary object.
  88        The default value for --window is 10 and --depth is 50.
  89
  90--window-memory=<n>::
  91        This option provides an additional limit on top of `--window`;
  92        the window size will dynamically scale down so as to not take
  93        up more than '<n>' bytes in memory.  This is useful in
  94        repositories with a mix of large and small objects to not run
  95        out of memory with a large window, but still be able to take
  96        advantage of the large window for the smaller objects.  The
  97        size can be suffixed with "k", "m", or "g".
  98        `--window-memory=0` makes memory usage unlimited, which is the
  99        default.
 100
 101--max-pack-size=<n>::
 102        Maximum size of each output pack file. The size can be suffixed with
 103        "k", "m", or "g". The minimum size allowed is limited to 1 MiB.
 104        If specified,  multiple packfiles may be created.
 105        The default is unlimited, unless the config variable
 106        `pack.packSizeLimit` is set.
 107
 108
 109Configuration
 110-------------
 111
 112By default, the command passes `--delta-base-offset` option to
 113'git pack-objects'; this typically results in slightly smaller packs,
 114but the generated packs are incompatible with versions of Git older than
 115version 1.4.4. If you need to share your repository with such ancient Git
 116versions, either directly or via the dumb http or rsync protocol, then you
 117need to set the configuration variable `repack.UseDeltaBaseOffset` to
 118"false" and repack. Access from old Git versions over the native protocol
 119is unaffected by this option as the conversion is performed on the fly
 120as needed in that case.
 121
 122
 123Author
 124------
 125Written by Linus Torvalds <torvalds@osdl.org>
 126
 127Documentation
 128--------------
 129Documentation by Ryan Anderson <ryan@michonline.com>
 130
 131SEE ALSO
 132--------
 133linkgit:git-pack-objects[1]
 134linkgit:git-prune-packed[1]
 135
 136GIT
 137---
 138Part of the linkgit:git[1] suite