Document git-pack-refs and link it to git(7).
[4msysgit-hv.git] / Documentation / git-pack-refs.txt
blob5da51057713a5553db26d871cc561b0df7ca94ff
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 'git-pack-refs' [--all] [--prune]
12 DESCRIPTION
13 -----------
15 Traditionally, tips of branches and tags (collectively known as
16 'refs') were stored one file per ref under `$GIT_DIR/refs`
17 directory.  While many branch tips tend to be updated often,
18 most tags and some branch tips are never updated.  When a
19 repository has hundreds or thousands of tags, this
20 one-file-per-ref format both wastes storage and hurts
21 performance.
23 This command is used to solve the storage and performance
24 problem by stashing the refs in a single file,
25 `$GIT_DIR/packed-refs`.  When a ref is missing from the
26 traditional `$GIT_DIR/refs` hierarchy, it is looked up in this
27 file and used if found.
29 Subsequent updates to branches always creates new file under
30 `$GIT_DIR/refs` hierarchy.
32 OPTIONS
33 -------
35 \--all::
37 The command by default packs all tags and leaves branch tips
38 alone.  This is because branches are expected to be actively
39 developed and packing their tips does not help performance.
40 This option causes branch tips to be packed as well.  Useful for
41 a repository with many branches of historical interests.
43 \--prune::
45 After packing the refs, remove loose refs under `$GIT_DIR/refs`
46 hierarchy.  This should probably become default.
48 Author
49 ------
50 Written by Linus Torvalds <torvalds@osdl.org>
52 GIT
53 ---
54 Part of the gitlink:git[7] suite