From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Sun, 7 Apr 2019 19:52:16 +0000 (+0200)
Subject: gc docs: clarify that "gc" doesn't throw away referenced objects
X-Git-Tag: v2.22.0-rc0~54^2~1
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/daecbf2261f595935c999a00a1f9bc433df80e2c?hp=daecbf2261f595935c999a00a1f9bc433df80e2c

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>
---