2005-09-08 00:26:23 +00:00
|
|
|
git-repack(1)
|
|
|
|
=============
|
2005-08-15 22:48:47 +00:00
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
2007-01-18 23:53:37 +00:00
|
|
|
git-repack - Pack unpacked objects in a repository
|
2005-08-15 22:48:47 +00:00
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2011-07-02 02:38:26 +00:00
|
|
|
[verse]
|
2013-12-21 14:00:31 +00:00
|
|
|
'git repack' [-a] [-A] [-d] [-f] [-F] [-l] [-n] [-q] [-b] [--window=<n>] [--depth=<n>]
|
2005-08-15 22:48:47 +00:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
|
2013-10-18 23:25:22 +00:00
|
|
|
This command is used to combine all objects that do not currently
|
2007-08-24 00:44:13 +00:00
|
|
|
reside in a "pack", into a pack. It can also be used to re-organize
|
2007-06-30 08:56:12 +00:00
|
|
|
existing packs into a single, more efficient pack.
|
2005-08-30 00:21:06 +00:00
|
|
|
|
|
|
|
A pack is a collection of objects, individually compressed, with
|
|
|
|
delta compression applied, stored in a single file, with an
|
|
|
|
associated index file.
|
|
|
|
|
|
|
|
Packs are used to reduce the load on mirror systems, backup
|
|
|
|
engines, disk storage, etc.
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
-------
|
|
|
|
|
|
|
|
-a::
|
|
|
|
Instead of incrementally packing the unpacked objects,
|
2007-06-30 08:56:12 +00:00
|
|
|
pack everything referenced into a single pack.
|
2005-08-30 00:21:06 +00:00
|
|
|
Especially useful when packing a repository that is used
|
2009-06-09 16:15:47 +00:00
|
|
|
for private development. Use
|
2007-06-30 08:56:12 +00:00
|
|
|
with '-d'. This will clean up the objects that `git prune`
|
2012-02-28 22:55:39 +00:00
|
|
|
leaves behind, but `git fsck --full --dangling` shows as
|
2007-06-30 08:56:12 +00:00
|
|
|
dangling.
|
2009-06-09 16:15:47 +00:00
|
|
|
+
|
|
|
|
Note that users fetching over dumb protocols will have to fetch the
|
|
|
|
whole new pack in order to get any contained object, no matter how many
|
|
|
|
other objects in that pack they already have locally.
|
2005-08-30 00:21:06 +00:00
|
|
|
|
2008-05-16 02:37:31 +00:00
|
|
|
-A::
|
2008-11-13 20:11:46 +00:00
|
|
|
Same as `-a`, unless '-d' is used. Then any unreachable
|
|
|
|
objects in a previous pack become loose, unpacked objects,
|
|
|
|
instead of being left in the old pack. Unreachable objects
|
|
|
|
are never intentionally added to a pack, even when repacking.
|
|
|
|
This option prevents unreachable objects from being immediately
|
2008-05-16 02:37:31 +00:00
|
|
|
deleted by way of being left in the old pack and then
|
|
|
|
removed. Instead, the loose unreachable objects
|
|
|
|
will be pruned according to normal expiry rules
|
2010-01-09 23:33:00 +00:00
|
|
|
with the next 'git gc' invocation. See linkgit:git-gc[1].
|
2008-05-16 02:37:31 +00:00
|
|
|
|
2005-08-30 00:21:06 +00:00
|
|
|
-d::
|
|
|
|
After packing, if the newly created packs make some
|
|
|
|
existing packs redundant, remove the redundant packs.
|
2010-01-09 23:33:00 +00:00
|
|
|
Also run 'git prune-packed' to remove redundant
|
2008-06-30 18:56:34 +00:00
|
|
|
loose object files.
|
2005-08-15 22:48:47 +00:00
|
|
|
|
2005-12-08 23:28:05 +00:00
|
|
|
-l::
|
2010-01-09 23:33:00 +00:00
|
|
|
Pass the `--local` option to 'git pack-objects'. See
|
2007-12-29 06:20:38 +00:00
|
|
|
linkgit:git-pack-objects[1].
|
2005-12-08 23:28:05 +00:00
|
|
|
|
2006-02-16 19:57:18 +00:00
|
|
|
-f::
|
2010-09-27 12:19:36 +00:00
|
|
|
Pass the `--no-reuse-delta` option to `git-pack-objects`, see
|
|
|
|
linkgit:git-pack-objects[1].
|
|
|
|
|
|
|
|
-F::
|
2008-09-19 13:43:48 +00:00
|
|
|
Pass the `--no-reuse-object` option to `git-pack-objects`, see
|
2007-12-29 06:20:38 +00:00
|
|
|
linkgit:git-pack-objects[1].
|
2006-02-16 19:57:18 +00:00
|
|
|
|
|
|
|
-q::
|
2010-01-09 23:33:00 +00:00
|
|
|
Pass the `-q` option to 'git pack-objects'. See
|
2007-12-29 06:20:38 +00:00
|
|
|
linkgit:git-pack-objects[1].
|
2006-02-16 19:57:18 +00:00
|
|
|
|
2005-12-08 23:28:05 +00:00
|
|
|
-n::
|
2008-05-22 12:47:19 +00:00
|
|
|
Do not update the server information with
|
2010-01-09 23:33:00 +00:00
|
|
|
'git update-server-info'. This option skips
|
2008-05-22 12:47:19 +00:00
|
|
|
updating local catalog files needed to publish
|
|
|
|
this repository (or a direct copy of it)
|
2008-07-03 04:54:38 +00:00
|
|
|
over HTTP or FTP. See linkgit:git-update-server-info[1].
|
2005-08-15 22:48:47 +00:00
|
|
|
|
2010-10-08 17:31:15 +00:00
|
|
|
--window=<n>::
|
|
|
|
--depth=<n>::
|
2006-10-06 09:15:03 +00:00
|
|
|
These two options affect how the objects contained in the pack are
|
2006-09-17 11:02:59 +00:00
|
|
|
stored using delta compression. The objects are first internally
|
|
|
|
sorted by type, size and optionally names and compared against the
|
|
|
|
other objects within `--window` to see if using delta compression saves
|
|
|
|
space. `--depth` limits the maximum delta depth; making it too deep
|
|
|
|
affects the performance on the unpacker side, because delta data needs
|
|
|
|
to be applied that many times to get to the necessary object.
|
2007-05-08 13:28:26 +00:00
|
|
|
The default value for --window is 10 and --depth is 50.
|
2006-09-17 11:02:59 +00:00
|
|
|
|
2010-10-08 17:31:15 +00:00
|
|
|
--window-memory=<n>::
|
2007-07-12 12:55:52 +00:00
|
|
|
This option provides an additional limit on top of `--window`;
|
|
|
|
the window size will dynamically scale down so as to not take
|
2010-10-08 17:31:15 +00:00
|
|
|
up more than '<n>' bytes in memory. This is useful in
|
2007-07-12 12:55:52 +00:00
|
|
|
repositories with a mix of large and small objects to not run
|
|
|
|
out of memory with a large window, but still be able to take
|
|
|
|
advantage of the large window for the smaller objects. The
|
|
|
|
size can be suffixed with "k", "m", or "g".
|
|
|
|
`--window-memory=0` makes memory usage unlimited, which is the
|
|
|
|
default.
|
|
|
|
|
2010-10-08 17:31:15 +00:00
|
|
|
--max-pack-size=<n>::
|
2010-02-04 03:48:28 +00:00
|
|
|
Maximum size of each output pack file. The size can be suffixed with
|
|
|
|
"k", "m", or "g". The minimum size allowed is limited to 1 MiB.
|
2007-05-13 19:47:09 +00:00
|
|
|
If specified, multiple packfiles may be created.
|
2010-02-04 03:48:28 +00:00
|
|
|
The default is unlimited, unless the config variable
|
|
|
|
`pack.packSizeLimit` is set.
|
2007-05-13 19:47:09 +00:00
|
|
|
|
2013-12-21 14:00:31 +00:00
|
|
|
-b::
|
|
|
|
--write-bitmap-index::
|
|
|
|
Write a reachability bitmap index as part of the repack. This
|
|
|
|
only makes sense when used with `-a` or `-A`, as the bitmaps
|
|
|
|
must be able to refer to all reachable objects. This option
|
2015-03-11 20:32:45 +00:00
|
|
|
overrides the setting of `pack.writeBitmaps`.
|
2013-12-21 14:00:31 +00:00
|
|
|
|
repack: add `repack.packKeptObjects` config var
The git-repack command always passes `--honor-pack-keep`
to pack-objects. This has traditionally been a good thing,
as we do not want to duplicate those objects in a new pack,
and we are not going to delete the old pack.
However, when bitmaps are in use, it is important for a full
repack to include all reachable objects, even if they may be
duplicated in a .keep pack. Otherwise, we cannot generate
the bitmaps, as the on-disk format requires the set of
objects in the pack to be fully closed.
Even if the repository does not generally have .keep files,
a simultaneous push could cause a race condition in which a
.keep file exists at the moment of a repack. The repack may
try to include those objects in one of two situations:
1. The pushed .keep pack contains objects that were
already in the repository (e.g., blobs due to a revert of
an old commit).
2. Receive-pack updates the refs, making the objects
reachable, but before it removes the .keep file, the
repack runs.
In either case, we may prefer to duplicate some objects in
the new, full pack, and let the next repack (after the .keep
file is cleaned up) take care of removing them.
This patch introduces both a command-line and config option
to disable the `--honor-pack-keep` option. By default, it
is triggered when pack.writeBitmaps (or `--write-bitmap-index`
is turned on), but specifying it explicitly can override the
behavior (e.g., in cases where you prefer .keep files to
bitmaps, but only when they are present).
Note that this option just disables the pack-objects
behavior. We still leave packs with a .keep in place, as we
do not necessarily know that we have duplicated all of their
objects.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-03-03 20:04:20 +00:00
|
|
|
--pack-kept-objects::
|
|
|
|
Include objects in `.keep` files when repacking. Note that we
|
|
|
|
still do not delete `.keep` packs after `pack-objects` finishes.
|
|
|
|
This means that we may duplicate objects, but this makes the
|
|
|
|
option safe to use when there are concurrent pushes or fetches.
|
|
|
|
This option is generally only useful if you are writing bitmaps
|
2015-03-11 20:32:45 +00:00
|
|
|
with `-b` or `pack.writeBitmaps`, as it ensures that the
|
repack: add `repack.packKeptObjects` config var
The git-repack command always passes `--honor-pack-keep`
to pack-objects. This has traditionally been a good thing,
as we do not want to duplicate those objects in a new pack,
and we are not going to delete the old pack.
However, when bitmaps are in use, it is important for a full
repack to include all reachable objects, even if they may be
duplicated in a .keep pack. Otherwise, we cannot generate
the bitmaps, as the on-disk format requires the set of
objects in the pack to be fully closed.
Even if the repository does not generally have .keep files,
a simultaneous push could cause a race condition in which a
.keep file exists at the moment of a repack. The repack may
try to include those objects in one of two situations:
1. The pushed .keep pack contains objects that were
already in the repository (e.g., blobs due to a revert of
an old commit).
2. Receive-pack updates the refs, making the objects
reachable, but before it removes the .keep file, the
repack runs.
In either case, we may prefer to duplicate some objects in
the new, full pack, and let the next repack (after the .keep
file is cleaned up) take care of removing them.
This patch introduces both a command-line and config option
to disable the `--honor-pack-keep` option. By default, it
is triggered when pack.writeBitmaps (or `--write-bitmap-index`
is turned on), but specifying it explicitly can override the
behavior (e.g., in cases where you prefer .keep files to
bitmaps, but only when they are present).
Note that this option just disables the pack-objects
behavior. We still leave packs with a .keep in place, as we
do not necessarily know that we have duplicated all of their
objects.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-03-03 20:04:20 +00:00
|
|
|
bitmapped packfile has the necessary objects.
|
2006-09-17 11:02:59 +00:00
|
|
|
|
2006-10-14 04:28:58 +00:00
|
|
|
Configuration
|
|
|
|
-------------
|
|
|
|
|
2010-02-04 21:19:35 +00:00
|
|
|
By default, the command passes `--delta-base-offset` option to
|
|
|
|
'git pack-objects'; this typically results in slightly smaller packs,
|
|
|
|
but the generated packs are incompatible with versions of Git older than
|
|
|
|
version 1.4.4. If you need to share your repository with such ancient Git
|
|
|
|
versions, either directly or via the dumb http or rsync protocol, then you
|
|
|
|
need to set the configuration variable `repack.UseDeltaBaseOffset` to
|
|
|
|
"false" and repack. Access from old Git versions over the native protocol
|
|
|
|
is unaffected by this option as the conversion is performed on the fly
|
|
|
|
as needed in that case.
|
2006-10-14 04:28:58 +00:00
|
|
|
|
2008-05-28 23:55:27 +00:00
|
|
|
SEE ALSO
|
2005-08-15 22:48:47 +00:00
|
|
|
--------
|
2007-12-29 06:20:38 +00:00
|
|
|
linkgit:git-pack-objects[1]
|
|
|
|
linkgit:git-prune-packed[1]
|
2005-08-15 22:48:47 +00:00
|
|
|
|
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|