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