aboutsummaryrefslogtreecommitdiff
path: root/refstore/reading.go
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-03-22 23:24:18 +0000
committerGravatar Runxi Yu2026-03-22 23:24:18 +0000
commitafd58b4e5882402d606728e4f2ee8e5cb2354939 (patch)
tree3e0fd2e495ac10fa2c2cd1ccaf54574d95550798 /refstore/reading.go
parentrefstore/files: UB on use after close (diff)
signatureNo signature
refstore: Update invariants v0.1.89
Diffstat (limited to 'refstore/reading.go')
-rw-r--r--refstore/reading.go4
1 files changed, 3 insertions, 1 deletions
diff --git a/refstore/reading.go b/refstore/reading.go
index 98a5bd51..3444f07f 100644
--- a/refstore/reading.go
+++ b/refstore/reading.go
@@ -7,7 +7,7 @@ type ReadingStore interface {
// Resolve resolves a reference name to either a symbolic or detached ref.
//
// Implementations should return value forms (ref.Detached or ref.Symbolic),
- // not pointer forms.
+ // not pointer forms. Returned refs do not borrow the store.
// If the reference does not exist, implementations should return
// ErrReferenceNotFound.
Resolve(name string) (ref.Ref, error)
@@ -26,6 +26,8 @@ type ReadingStore interface {
List(pattern string) ([]ref.Ref, error)
// Close releases resources associated with the store.
//
+ // Transactions and batches borrowing the store are invalid after Close.
+ //
// Repeated calls to Close are undefined behavior unless the implementation
// explicitly documents otherwise.
Close() error