Documentation: pack-refs --all vs default behaviour
Document the recommended way to prime a repository with tons of references with 'pack-refs --all -prune'. Signed-off-by: Junio C Hamano <junkio@cox.net>
Junio C Hamano committed
Jan 25, 2007 at 22:51 UTC
af67e91c39aff2d955e9c325c6c4e843d5faef60
1 file changed
+12
-1
Documentation/git-pack-refs.txt
+12
-1
@@ -29,12 +29,23 @@ file and used if found.
29
Subsequent updates to branches always creates new file under
30
`$GIT_DIR/refs` hierarchy.
31
32
+A recommended practice to deal with a repository with too many
33
+refs is to pack its refs with `--all --prune` once, and
34
+occasionally run `git-pack-refs \--prune`. Tags are by
35
+definition stationary and are not expected to change. Branch
36
+heads will be packed with the initial `pack-refs --all`, but
37
+only the currently active branch heads will become unpacked,
38
+and next `pack-refs` (without `--all`) will leave them
39
+unpacked.
40
+
41
+
42
OPTIONS
43
-------
44
45
\--all::
46
37
-The command by default packs all tags and leaves branch tips
47
+The command by default packs all tags and refs that are already
48
+packed, and leaves other refs
49
alone. This is because branches are expected to be actively
50
developed and packing their tips does not help performance.
51
This option causes branch tips to be packed as well. Useful for