Skip to content

Commit

Permalink
Documentation: pack-refs --all vs default behaviour
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Junio C Hamano committed Jan 26, 2007
1 parent df373ea commit af67e91
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion Documentation/git-pack-refs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit af67e91

Please sign in to comment.