"GOT", but the "O" is a cute, smiling pufferfish. Index | Thread | Search

From:
Stefan Sperling <stsp@stsp.name>
Subject:
improve got ref -d docs
To:
gameoftrees@openbsd.org
Date:
Sun, 21 Mar 2021 19:55:16 +0100

Download raw body.

Thread
The distinction between deleting a reference and deleting objects is
an important one, so I'd like to mention it in the docs of got ref -d.

This is self-evident to advanced users and also mentioned elsewhere,
but it might get overlooked if a new user wants to use ref -d specifically
to get rid of old automatically backed up commits.

Since we don't have our own garbage collector yet, we recommend
the one from Git; this is also done elsewhere and can be adjusted
once we have our own.

ok?

diff 4e20a6488836bfbb096ecad1bad212e094cc8624 /home/stsp/src/got
blob - 5b538ecd34e3cfd6ed3313e82c52125d334b4c3e
file + got/got.1
--- got/got.1
+++ got/got.1
@@ -972,6 +972,9 @@ Cannot be used together with any other options except
 Delete the reference with the specified
 .Ar name
 from the repository.
+Any commit, tree, tag, and blob objects belonging to deleted references
+remain in the repository and may be removed separately with
+Git's garbage collector.
 Cannot be used together with any other options except
 .Fl r .
 .El