From 5168707749f9c29c01459a7d5344f33ebd9c315c Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sat, 28 Mar 2026 15:41:58 +0000 Subject: object/store/loose: Update docs --- object/store/loose/read_reader.go | 4 ---- object/store/loose/store.go | 8 ++++---- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/object/store/loose/read_reader.go b/object/store/loose/read_reader.go index 29b71627..c8c8d736 100644 --- a/object/store/loose/read_reader.go +++ b/object/store/loose/read_reader.go @@ -53,8 +53,6 @@ func (store *Store) openInflated(id objectid.ObjectID) (*os.File, io.ReadCloser, // ReadReaderFull reads a full serialized object stream as "type size\0content". // -// The caller must close the returned reader. -// // Close releases resources only. It does not drain unread data for additional // validation. In particular, malformed trailing compressed data, trailing bytes // past the declared object size, and the zlib Adler-32 trailer may go @@ -88,8 +86,6 @@ func (store *Store) ReadReaderFull(id objectid.ObjectID) (io.ReadCloser, error) // ReadReaderContent reads an object's type, declared content length, and // content stream. // -// The caller must close the returned reader. -// // Close releases resources only. It does not drain unread data for additional // validation. In particular, malformed trailing compressed data, trailing bytes // past the declared object size, and the zlib Adler-32 trailer may go diff --git a/object/store/loose/store.go b/object/store/loose/store.go index d8eba84e..9f0493fe 100644 --- a/object/store/loose/store.go +++ b/object/store/loose/store.go @@ -12,6 +12,8 @@ import ( // Loose objects are zlib streams whose trailer uses Adler-32. Which reads // consume enough of the stream to reach and verify that trailer is documented // on the individual methods. +// +// Labels: Close-Caller. type Store struct { // root is the objects directory capability used for all object file access. // Object files are opened by relative paths like "/". @@ -22,6 +24,8 @@ type Store struct { } // New creates a loose-object store rooted at an objects directory for algo. +// +// Labels: Deps-Borrowed. func New(root *os.Root, algo objectid.Algorithm) (*Store, error) { if algo.Size() == 0 { return nil, objectid.ErrInvalidAlgorithm @@ -34,8 +38,4 @@ func New(root *os.Root, algo objectid.Algorithm) (*Store, error) { } // Close releases resources associated with the backend. -// -// Store borrows its root, so Close does not close it. -// -// Repeated calls to Close are undefined behavior. func (store *Store) Close() error { return nil } -- cgit v1.3.1-10-gc9f91