]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-repack.txt
Add default values for --window and --depth to the docs
[thirdparty/git.git] / Documentation / git-repack.txt
CommitLineData
215a7ad1
JH
1git-repack(1)
2=============
e31bb3bb
JH
3
4NAME
5----
215a7ad1 6git-repack - Script used to pack a repository from a collection of
e31bb3bb
JH
7objects into pack files.
8
9
10SYNOPSIS
11--------
02ac04fc 12'git-repack' [-a] [-d] [-f] [-l] [-n] [-q] [--window=N] [--depth=N]
e31bb3bb
JH
13
14DESCRIPTION
15-----------
e31bb3bb 16
f85a4191
JH
17This script is used to combine all objects that do not currently
18reside in a "pack", into a 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 available into a single pack.
33 Especially useful when packing a repository that is used
34 for a private development and there no need to worry
35 about people fetching via dumb protocols from it. Use
36 with '-d'.
37
38-d::
39 After packing, if the newly created packs make some
40 existing packs redundant, remove the redundant packs.
2b5f3ed3 41 Also runs gitlink:git-prune-packed[1].
e31bb3bb 42
31f23281
NW
43-l::
44 Pass the `--local` option to `git pack-objects`, see
45 gitlink:git-pack-objects[1].
46
cec2be76
JH
47-f::
48 Pass the `--no-reuse-delta` option to `git pack-objects`, see
49 gitlink:git-pack-objects[1].
50
51-q::
52 Pass the `-q` option to `git pack-objects`, see
53 gitlink:git-pack-objects[1].
54
31f23281
NW
55-n::
56 Do not update the server information with
57 `git update-server-info`.
e31bb3bb 58
02ac04fc 59--window=[N], --depth=[N]::
3df19671 60 These two options affect how the objects contained in the pack are
02ac04fc
JF
61 stored using delta compression. The objects are first internally
62 sorted by type, size and optionally names and compared against the
63 other objects within `--window` to see if using delta compression saves
64 space. `--depth` limits the maximum delta depth; making it too deep
65 affects the performance on the unpacker side, because delta data needs
66 to be applied that many times to get to the necessary object.
3df19671 67 The default value for both --window and --depth is 10.
02ac04fc
JF
68
69
e31bb3bb
JH
70Author
71------
72Written by Linus Torvalds <torvalds@osdl.org>
73
74Documentation
75--------------
76Documentation by Ryan Anderson <ryan@michonline.com>
77
46444f51 78See Also
e31bb3bb 79--------
df8baa42
JF
80gitlink:git-pack-objects[1]
81gitlink:git-prune-packed[1]
e31bb3bb
JH
82
83GIT
84---
a7154e91 85Part of the gitlink:git[7] suite
e31bb3bb 86