From f04d559bc56cb6002203e2ba84aeeff7e2cd8442 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sat, 28 Mar 2026 17:20:16 +0000 Subject: format/commitgraph/read: Update docs --- format/commitgraph/read/bloom.go | 2 ++ format/commitgraph/read/close.go | 2 +- format/commitgraph/read/open.go | 2 +- format/commitgraph/read/reader.go | 4 +--- 4 files changed, 5 insertions(+), 5 deletions(-) (limited to 'format/commitgraph/read') diff --git a/format/commitgraph/read/bloom.go b/format/commitgraph/read/bloom.go index 12dd6db3..53d724f9 100644 --- a/format/commitgraph/read/bloom.go +++ b/format/commitgraph/read/bloom.go @@ -42,6 +42,8 @@ func (reader *Reader) BloomVersion() uint8 { // only valid until the reader is closed. // // Returns BloomUnavailableError when this commit graph has no Bloom data. +// +// Labels: Life-Parent. func (reader *Reader) BloomFilterAt(pos Position) (bloom.Filter, error) { layer, err := reader.layerByPosition(pos) if err != nil { diff --git a/format/commitgraph/read/close.go b/format/commitgraph/read/close.go index f8b6141a..8fd1bbf2 100644 --- a/format/commitgraph/read/close.go +++ b/format/commitgraph/read/close.go @@ -2,7 +2,7 @@ package read // Close releases all mapped commit-graph files. // -// Repeated calls to Close are undefined behavior. +// Labels: Close-UB. func (reader *Reader) Close() error { var closeErr error diff --git a/format/commitgraph/read/open.go b/format/commitgraph/read/open.go index 9c708b49..d03c8572 100644 --- a/format/commitgraph/read/open.go +++ b/format/commitgraph/read/open.go @@ -9,7 +9,7 @@ import ( // Open opens commit-graph data from one objects root. // -// Open borrows root during construction and does not close it. +// Labels: Deps-Borrowed. func Open(root *os.Root, algo objectid.Algorithm, mode OpenMode) (*Reader, error) { if algo.Size() == 0 { return nil, objectid.ErrInvalidAlgorithm diff --git a/format/commitgraph/read/reader.go b/format/commitgraph/read/reader.go index d5c84a70..7a8659c1 100644 --- a/format/commitgraph/read/reader.go +++ b/format/commitgraph/read/reader.go @@ -4,9 +4,7 @@ import objectid "codeberg.org/lindenii/furgit/object/id" // 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. +// Labels: MT-ReadSafe, Close-Caller. type Reader struct { algo objectid.Algorithm hashVersion uint8 -- cgit v1.3.1-10-gc9f91