aboutsummaryrefslogtreecommitdiff
path: root/repository/reachability.go
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-03-29 08:09:34 +0000
committerGravatar Runxi Yu2026-03-29 08:09:34 +0000
commit161d2fab0b7ddee35696c5600d3ebd5bae6e6527 (patch)
tree887cd546fe3a05489cd3b4e37f9a4bf2770e50f1 /repository/reachability.go
parent*: Remove Close exception for MT-Safe (diff)
repository: Add guidance
Diffstat (limited to 'repository/reachability.go')
-rw-r--r--repository/reachability.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/repository/reachability.go b/repository/reachability.go
index 4e6a4559..24f9e2bd 100644
--- a/repository/reachability.go
+++ b/repository/reachability.go
@@ -5,6 +5,9 @@ import "codeberg.org/lindenii/furgit/reachability"
// Reachability returns graph traversal helpers backed by the repository's
// object store and optional commit-graph.
//
+// Use Reachability to walk reachable commits or objects and to perform
+// connectivity checks.
+//
// Labels: Life-Parent, Close-No.
func (repo *Repository) Reachability() *reachability.Reachability {
return reachability.New(repo.objects, repo.commitGraph)