mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-06-09 12:56:12 +02:00
Code

Document git-pack-refs and link it to git(7). 

Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Junio C Hamano 2006-11-06 00:28:52 -08:00
parent a79c6551a3
commit d28f7cb935
2 changed files with 60 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
Documentation/git-pack-refs.txt Normal file
View File

@ -0,0 +1,54 @@
git-pack-refs(1)
================
NAME
----
git-pack-refs - Pack heads and tags for efficient repository access
SYNOPSIS
--------
'git-pack-refs' [--all] [--prune]
DESCRIPTION
-----------
Traditionally, tips of branches and tags (collectively known as
'refs') were stored one file per ref under `$GIT_DIR/refs`
directory. While many branch tips tend to be updated often,
most tags and some branch tips are never updated. When a
repository has hundreds or thousands of tags, this
one-file-per-ref format both wastes storage and hurts
performance.
This command is used to solve the storage and performance
problem by stashing the refs in a single file,
`$GIT_DIR/packed-refs`. When a ref is missing from the
traditional `$GIT_DIR/refs` hierarchy, it is looked up in this
file and used if found.
Subsequent updates to branches always creates new file under
`$GIT_DIR/refs` hierarchy.
OPTIONS
-------
\--all::
The command by default packs all tags and leaves branch tips
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
a repository with many branches of historical interests.
\--prune::
After packing the refs, remove loose refs under `$GIT_DIR/refs`
hierarchy. This should probably become default.
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
GIT
---
Part of the gitlink:git[7] suite

6
Documentation/git.txt
View File

@ -141,6 +141,9 @@ gitlink:git-merge[1]::
gitlink:git-mv[1]::
Move or rename a file, a directory, or a symlink.
gitlink:git-pack-refs[1]::
Pack heads and tags for efficient repository access.
gitlink:git-pull[1]::
Fetch from and merge with a remote repository or a local branch.
@ -424,6 +427,9 @@ gitlink:git-rev-list[1]::
gitlink:git-show-index[1]::
Displays contents of a pack idx file.
gitlink:git-show-ref[1]::
List references in a local repository.
gitlink:git-tar-tree[1]::
Creates a tar archive of the files in the named tree object.