The twelfth batch
[alt-git.git] / Documentation / git-pack-refs.txt
blob284956acb3c5e8bb168626c9729a17a799c0afd7
1 git-pack-refs(1)
2 ================
4 NAME
5 ----
6 git-pack-refs - Pack heads and tags for efficient repository access
8 SYNOPSIS
9 --------
10 [verse]
11 'git pack-refs' [--all] [--no-prune] [--include <pattern>] [--exclude <pattern>]
13 DESCRIPTION
14 -----------
16 Traditionally, tips of branches and tags (collectively known as
17 'refs') were stored one file per ref in a (sub)directory
18 under `$GIT_DIR/refs`
19 directory.  While many branch tips tend to be updated often,
20 most tags and some branch tips are never updated.  When a
21 repository has hundreds or thousands of tags, this
22 one-file-per-ref format both wastes storage and hurts
23 performance.
25 This command is used to solve the storage and performance
26 problem by storing the refs in a single file,
27 `$GIT_DIR/packed-refs`.  When a ref is missing from the
28 traditional `$GIT_DIR/refs` directory hierarchy, it is looked
29 up in this
30 file and used if found.
32 Subsequent updates to branches always create new files under
33 `$GIT_DIR/refs` directory hierarchy.
35 A recommended practice to deal with a repository with too many
36 refs is to pack its refs with `--all` once, and
37 occasionally run `git pack-refs`.  Tags are by
38 definition stationary and are not expected to change.  Branch
39 heads will be packed with the initial `pack-refs --all`, but
40 only the currently active branch heads will become unpacked,
41 and the next `pack-refs` (without `--all`) will leave them
42 unpacked.
45 OPTIONS
46 -------
48 --all::
50 The command by default packs all tags and refs that are already
51 packed, and leaves other refs
52 alone.  This is because branches are expected to be actively
53 developed and packing their tips does not help performance.
54 This option causes all refs to be packed as well, with the exception
55 of hidden refs, broken refs, and symbolic refs. Useful for a repository
56 with many branches of historical interests.
58 --no-prune::
60 The command usually removes loose refs under `$GIT_DIR/refs`
61 hierarchy after packing them.  This option tells it not to.
63 --include <pattern>::
65 Pack refs based on a `glob(7)` pattern. Repetitions of this option
66 accumulate inclusion patterns. If a ref is both included in `--include` and
67 `--exclude`, `--exclude` takes precedence. Using `--include` will preclude all
68 tags from being included by default. Symbolic refs and broken refs will never
69 be packed. When used with `--all`, it will be a noop. Use `--no-include` to clear
70 and reset the list of patterns.
72 --exclude <pattern>::
74 Do not pack refs matching the given `glob(7)` pattern. Repetitions of this option
75 accumulate exclusion patterns. Use `--no-exclude` to clear and reset the list of
76 patterns. If a ref is already packed, including it with `--exclude` will not
77 unpack it.
79 When used with `--all`, pack only loose refs which do not match any of
80 the provided `--exclude` patterns.
82 When used with `--include`, refs provided to `--include`, minus refs that are
83 provided to `--exclude` will be packed.
86 BUGS
87 ----
89 Older documentation written before the packed-refs mechanism was
90 introduced may still say things like ".git/refs/heads/<branch> file
91 exists" when it means "branch <branch> exists".
94 GIT
95 ---
96 Part of the linkgit:git[1] suite