diff options
Diffstat (limited to 'refstore/reading.go')
| -rw-r--r-- | refstore/reading.go | 4 |
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 |