aboutsummaryrefslogtreecommitdiffstats
path: root/storage/transactional/doc.go
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2019-02-02 10:14:24 +0100
committerMáximo Cuadros <mcuadros@gmail.com>2019-02-02 10:14:24 +0100
commit96317743391ac87aeb07d292469e212671628437 (patch)
tree990bbe4a11241f2ac3a5f4a71d514884b9c2b962 /storage/transactional/doc.go
parent12dc3ef13e5c783b9e304aa8b6a2f7097880ab87 (diff)
downloadgo-git-96317743391ac87aeb07d292469e212671628437.tar.gz
storage: transactional, package documentation
Signed-off-by: Máximo Cuadros <mcuadros@gmail.com>
Diffstat (limited to 'storage/transactional/doc.go')
-rw-r--r--storage/transactional/doc.go7
1 files changed, 7 insertions, 0 deletions
diff --git a/storage/transactional/doc.go b/storage/transactional/doc.go
new file mode 100644
index 0000000..3a68f5f
--- /dev/null
+++ b/storage/transactional/doc.go
@@ -0,0 +1,7 @@
+// Package transactional is a transactional implementation of git.Storer, it
+// demux the write and read operation of two separate storers, allowing to merge
+// content calling Storage.Commit.
+//
+// The API and functionality of this package are considered EXPERIMENTAL and is
+// not considered stable nor production ready.
+package transactional