Merge branch 'maint'
[git/git.git] / Documentation / git-repack.txt
1 git-repack(1)
2 =============
3
4 NAME
5 ----
6 git-repack - Script used to pack a repository from a collection of
7 objects into pack files.
8
9
10 SYNOPSIS
11 --------
12 'git-repack' [-a] [-d] [-f] [-l] [-n] [-q] [--window=N] [--depth=N]
13
14 DESCRIPTION
15 -----------
16
17 This script is used to combine all objects that do not currently
18 reside in a "pack", into a 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 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.
41 Also runs gitlink:git-prune-packed[1].
42
43 -l::
44 Pass the `--local` option to `git pack-objects`, see
45 gitlink:git-pack-objects[1].
46
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
55 -n::
56 Do not update the server information with
57 `git update-server-info`.
58
59 --window=[N], --depth=[N]::
60 These two options affect how the objects contained in the pack are
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.
67 The default value for both --window and --depth is 10.
68
69
70 Author
71 ------
72 Written by Linus Torvalds <torvalds@osdl.org>
73
74 Documentation
75 --------------
76 Documentation by Ryan Anderson <ryan@michonline.com>
77
78 See Also
79 --------
80 gitlink:git-pack-objects[1]
81 gitlink:git-prune-packed[1]
82
83 GIT
84 ---
85 Part of the gitlink:git[7] suite
86