]> git.ipfire.org Git - thirdparty/git.git/commit
docs: clarify that refs/notes/ do not keep the attached objects alive
authorMartin von Zweigbergk <martinvonz@google.com>
Thu, 11 Feb 2021 07:39:14 +0000 (23:39 -0800)
committerJunio C Hamano <gitster@pobox.com>
Thu, 11 Feb 2021 07:43:55 +0000 (23:43 -0800)
commitfa9ab027bac58e4133b6fcea82c459934edb03b1
tree34e8be454456c00a2fe538743e43231cd9e2a274
parent773e25afc41b1b6533fa9ae2cd825d0b4a697fad
docs: clarify that refs/notes/ do not keep the attached objects alive

`git help gc` contains this snippet:

  "[...] it will keep [..] objects referenced by the index,
  remote-tracking branches, notes saved by git notes under refs/notes/"

I had interpreted that as saying that the objects that notes were
attached to are kept, but that is not the case. Let's clarify the
documentation by moving out the part about git notes to a separate
sentence.

Signed-off-by: Martin von Zweigbergk <martinvonz@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-gc.txt