doc/git-gc: add a note about what is collected

It seems to be a FAQ that people try running git-gc, and
then get puzzled about why the size of their .git directory
didn't change. This note mentions the reasons why things
might unexpectedly get kept.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jeff King 2008-04-23 21:28:36 -04:00 коммит произвёл Junio C Hamano
Родитель d6958a1a32
Коммит 3ffb58be0a
1 изменённых файлов: 15 добавлений и 0 удалений

Просмотреть файл

@ -104,6 +104,21 @@ The optional configuration variable 'gc.pruneExpire' controls how old
the unreferenced loose objects have to be before they are pruned. The
default is "2 weeks ago".
Notes
-----
git-gc tries very hard to be safe about the garbage it collects. In
particular, it will keep not only objects referenced by your current set
of branches and tags, but also objects referenced by the index, remote
tracking branches, refs saved by linkgit:git-filter-branch[1] in
refs/original/, or reflogs (which may references commits in branches
that were later amended or rewound).
If you are expecting some objects to be collected and they aren't, check
all of those locations and decide whether it makes sense in your case to
remove those references.
See Also
--------
linkgit:git-prune[1]