docs: add doc-comments on GC-related methods

Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
2022-01-24 14:23:16 -08:00
parent 731518417e
commit f048a25938
5 changed files with 11 additions and 1 deletions
--- a/metadata/content.go
+++ b/metadata/content.go
@@ -772,6 +772,7 @@ func writeExpireAt(expire time.Time, bkt *bolt.Bucket) error {
 	return bkt.Put(bucketKeyExpireAt, expireAt)
 }

+// garbageCollect removes all contents that are no longer used.
 func (cs *contentStore) garbageCollect(ctx context.Context) (d time.Duration, err error) {
 	cs.l.Lock()
 	t1 := time.Now()