aboutsummaryrefslogtreecommitdiffstats
path: root/plumbing/object/commitgraph/doc.go
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2019-05-14 16:51:33 +0200
committerGitHub <noreply@github.com>2019-05-14 16:51:33 +0200
commit52fcf7d8a3c2da58769e105a26240e3e697fedeb (patch)
treeed4fe508e6d78a459af7e74421769a6a9954e446 /plumbing/object/commitgraph/doc.go
parente17ee112ca6cc7db0a732c0676b61511e84ec899 (diff)
parentd2596b8d7fe07aecf83b5377c527f5d8999f7d16 (diff)
downloadgo-git-52fcf7d8a3c2da58769e105a26240e3e697fedeb.tar.gz
Merge pull request #1132 from filipnavara/commitgraph-obj
plumbing: object, add APIs for traversing over commit graphs
Diffstat (limited to 'plumbing/object/commitgraph/doc.go')
-rw-r--r--plumbing/object/commitgraph/doc.go7
1 files changed, 7 insertions, 0 deletions
diff --git a/plumbing/object/commitgraph/doc.go b/plumbing/object/commitgraph/doc.go
new file mode 100644
index 0000000..0a55ad5
--- /dev/null
+++ b/plumbing/object/commitgraph/doc.go
@@ -0,0 +1,7 @@
+// Package commitgraph provides an interface for efficient traversal over Git
+// commit graph either through the regular object storage, or optionally with
+// the index stored in commit-graph file (Git 2.18+).
+//
+// The API and functionality of this package are considered EXPERIMENTAL and is
+// not considered stable nor production ready.
+package commitgraph