diff options
Diffstat (limited to 'repository/commit_graph.go')
| -rw-r--r-- | repository/commit_graph.go | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/repository/commit_graph.go b/repository/commit_graph.go index 3f0a0888..4f210b56 100644 --- a/repository/commit_graph.go +++ b/repository/commit_graph.go @@ -31,6 +31,11 @@ func openCommitGraph(root *os.Root, algo objectid.Algorithm) (*commitgraphread.R // CommitGraph returns the configured commit-graph reader, if available. // +// Not all repositories have a commit-graph, so CommitGraph may return nil. +// Most callers should prefer [Repository.CommitQueries] or +// [Repository.Reachability] unless they specifically need direct +// commit-graph access. +// // Labels: Life-Parent, Close-No. func (repo *Repository) CommitGraph() *commitgraphread.Reader { return repo.commitGraph |