aboutsummaryrefslogtreecommitdiff
path: root/commitgraph/read/reader.go
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-03-22 22:52:35 +0000
committerGravatar Runxi Yu2026-03-22 22:52:35 +0000
commit1ac6099100ed61a1e49766f190deae8b426a1ea6 (patch)
treea218663581161484942017575b9e7ebd969e06de /commitgraph/read/reader.go
parentpackfile/ingest: Document lifecycle of pack ingest better (diff)
signatureNo signature
commitgraph: Tighten docs and use a value-ish Filter return
Diffstat (limited to 'commitgraph/read/reader.go')
-rw-r--r--commitgraph/read/reader.go2
1 files changed, 2 insertions, 0 deletions
diff --git a/commitgraph/read/reader.go b/commitgraph/read/reader.go
index 922d459b..ab68f31c 100644
--- a/commitgraph/read/reader.go
+++ b/commitgraph/read/reader.go
@@ -5,6 +5,8 @@ import "codeberg.org/lindenii/furgit/objectid"
// Reader provides read-only access to one mmap-backed commit-graph snapshot.
//
// It is safe for concurrent read-only queries.
+// Values returned by Reader methods are only valid until the reader is closed
+// when explicitly documented on that method.
type Reader struct {
algo objectid.Algorithm
hashVersion uint8