summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2007-01-26 06:51:49 (GMT)
committerJunio C Hamano <junkio@cox.net>2007-01-26 08:02:51 (GMT)
commitaf67e91c39aff2d955e9c325c6c4e843d5faef60 (patch)
tree650150718ae39ab186352323430450bbb7bb6a5e
parentdf373ea99a1cf3056a72bad1d66f0e62f3b41c20 (diff)
downloadgit-af67e91c39aff2d955e9c325c6c4e843d5faef60.zip
git-af67e91c39aff2d955e9c325c6c4e843d5faef60.tar.gz
git-af67e91c39aff2d955e9c325c6c4e843d5faef60.tar.bz2
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>
-rw-r--r--Documentation/git-pack-refs.txt13
1 files changed, 12 insertions, 1 deletions
diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt
index 464269f..a20fc7d 100644
--- a/Documentation/git-pack-refs.txt
+++ b/Documentation/git-pack-refs.txt
@@ -29,12 +29,23 @@ file and used if found.
Subsequent updates to branches always creates new file under
`$GIT_DIR/refs` hierarchy.
+A recommended practice to deal with a repository with too many
+refs is to pack its refs with `--all --prune` once, and
+occasionally run `git-pack-refs \--prune`. Tags are by
+definition stationary and are not expected to change. Branch
+heads will be packed with the initial `pack-refs --all`, but
+only the currently active branch heads will become unpacked,
+and next `pack-refs` (without `--all`) will leave them
+unpacked.
+
+
OPTIONS
-------
\--all::
-The command by default packs all tags and leaves branch tips
+The command by default packs all tags and refs that are already
+packed, and leaves other refs
alone. This is because branches are expected to be actively
developed and packing their tips does not help performance.
This option causes branch tips to be packed as well. Useful for