mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

gc docs: clarify that "gc" doesn't throw away referenced objects

Browse Source 
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>
This commit is contained in:
Ævar Arnfjörð Bjarmason
2019-04-07 21:52:16 +02:00
committed by Junio C Hamano
parent 7384504881
commit daecbf2261
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/git-gc.txt
View File

@ -119,8 +119,8 @@ anywhere in your repository. In
particular, it will keep not only objects referenced by your current set particular, it will keep not only objects referenced by your current set
of branches and tags, but also objects referenced by the index, of branches and tags, but also objects referenced by the index,
remote-tracking branches, refs saved by 'git filter-branch' in remote-tracking branches, refs saved by 'git filter-branch' in
refs/original/, or reflogs (which may reference commits in branches refs/original/, reflogs (which may reference commits in branches
that were later amended or rewound). that were later amended or rewound), and anything else in the refs/* namespace.
If you are expecting some objects to be deleted and they aren't, check If you are expecting some objects to be deleted and they aren't, check
all of those locations and decide whether it makes sense in your case to all of those locations and decide whether it makes sense in your case to
remove those references. remove those references.