From 65addf11cbdfbffe9f55a3fbe3964cab9ca89440 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sat, 21 Feb 2026 04:08:24 +0800 Subject: refstore: Document that ref.Detached/Symbolic should be values, not pointers. --- refstore/refstore.go | 3 +++ 1 file changed, 3 insertions(+) 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) -- cgit v1.3.1-10-gc9f91