diff options
| author |  Runxi Yu | 2026-02-21 04:08:24 +0800 |
|---|---|---|
| committer | Runxi Yu | 2026-02-21 04:08:24 +0800 |
| commit | 65addf11cbdfbffe9f55a3fbe3964cab9ca89440 (patch) | |
| tree | 246ddb97762a314583bc1744dab4785c7004fd58 /refstore | |
| parent | objectstore/loose: Simplify ReadBytes* with a helper (diff) | |
| signature | No signature | |
refstore: Document that ref.Detached/Symbolic should be values, not
pointers.
Diffstat (limited to 'refstore')
| -rw-r--r-- | refstore/refstore.go | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/refstore/refstore.go b/refstore/refstore.go index 24e75115..a3c9f201 100644 --- a/refstore/refstore.go +++ b/refstore/refstore.go @@ -13,6 +13,9 @@ var ErrReferenceNotFound = errors.New("refstore: reference not found") // Store reads Git references. type Store 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. // If the reference does not exist, implementations should return // ErrReferenceNotFound. Resolve(name string) (ref.Ref, error) |