aboutsummaryrefslogtreecommitdiffstats
path: root/plumbing/object/commitgraph
diff options
context:
space:
mode:
authorFilip Navara <filip.navara@gmail.com>2019-05-07 10:49:39 +0200
committerFilip Navara <filip.navara@gmail.com>2019-05-07 10:49:39 +0200
commit7d2695741f4d1f572a36f7225b6bbb2f569d59d7 (patch)
treee794d037e57d13a816a162fe1c31ab6ce45d58c0 /plumbing/object/commitgraph
parent940460f5422b02f01351396af703e9b63e8596ae (diff)
downloadgo-git-7d2695741f4d1f572a36f7225b6bbb2f569d59d7.tar.gz
Add doc.go for commitgraph packages
Signed-off-by: Filip Navara <filip.navara@gmail.com>
Diffstat (limited to 'plumbing/object/commitgraph')
-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