Fast implementation of Git in pure Go
codeberg.org/lindenii/furgit
git
go
format/commitgraph/read: Update docs
+5
-5
+2
format/commitgraph/read/bloom.go
+2
format/commitgraph/read/bloom.go
···
42
42
// only valid until the reader is closed.
43
43
//
44
44
// Returns BloomUnavailableError when this commit graph has no Bloom data.
45
+
//
46
+
// Labels: Life-Parent.
45
47
func (reader *Reader) BloomFilterAt(pos Position) (bloom.Filter, error) {
46
48
layer, err := reader.layerByPosition(pos)
47
49
if err != nil {
+1
-1
format/commitgraph/read/close.go
+1
-1
format/commitgraph/read/close.go
+1
-1
format/commitgraph/read/open.go
+1
-1
format/commitgraph/read/open.go
···
9
9
10
10
// Open opens commit-graph data from one objects root.
11
11
//
12
-
// Open borrows root during construction and does not close it.
12
+
// Labels: Deps-Borrowed.
13
13
func Open(root *os.Root, algo objectid.Algorithm, mode OpenMode) (*Reader, error) {
14
14
if algo.Size() == 0 {
15
15
return nil, objectid.ErrInvalidAlgorithm
+1
-3
format/commitgraph/read/reader.go
+1
-3
format/commitgraph/read/reader.go
···
4
4
5
5
// Reader provides read-only access to one mmap-backed commit-graph snapshot.
6
6
//
7
-
// It is safe for concurrent read-only queries.
8
-
// Values returned by Reader methods are only valid until the reader is closed
9
-
// when explicitly documented on that method.
7
+
// Labels: MT-ReadSafe, Close-Caller.
10
8
type Reader struct {
11
9
algo objectid.Algorithm
12
10
hashVersion uint8