]> git.ipfire.org Git - thirdparty/git.git/commit
gc docs: clarify that "gc" doesn't throw away referenced objects
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Sun, 7 Apr 2019 19:52:16 +0000 (21:52 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 8 Apr 2019 08:01:09 +0000 (17:01 +0900)
commitdaecbf2261f595935c999a00a1f9bc433df80e2c
treeb7ab24622b02c352cc6fa618c7f16a0e97d73d76
parent73845048815bace98588df03ab76fa3e85fc0927
gc docs: clarify that "gc" doesn't throw away referenced objects

Amend the "NOTES" section to fix up wording that's been with us since
3ffb58be0a ("doc/git-gc: add a note about what is collected",
2008-04-23).

I can't remember when/where anymore (I think Freenode #Git), but at
some point I was having a conversation with someone who was convinced
that "gc" would prune things only referenced by e.g. refs/pull/*, and
pointed to this section as proof.

It turned out that they'd read the "branches and tags" wording here
and thought just refs/{heads,tags}/* and refs/remotes/* etc. would be
kept, which is what we enumerate explicitly.

So let's say "other refs", even though just above we say "objects that
are referenced anywhere in your repository".

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-gc.txt