aboutsummaryrefslogtreecommitdiff
path: root/object/store/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'object/store/doc.go')
-rw-r--r--object/store/doc.go19
1 files changed, 0 insertions, 19 deletions
diff --git a/object/store/doc.go b/object/store/doc.go
deleted file mode 100644
index 45acc47c..00000000
--- a/object/store/doc.go
+++ /dev/null
@@ -1,19 +0,0 @@
-// Package objectstore provides interfaces for object storage backends.
-//
-// Reading stores only respond to object-ID queries in terms of headers (type
-// and size), raw bytes, and streaming payloads, but they do not parse commits,
-// trees, blobs, or tags into typed values. Turning stored objects into typed
-// objects is the job of [codeberg.org/lindenii/furgit/object/fetch].
-//
-// This package does not define one unified writing interface. Backends have
-// very different write models: writing one loose object is natural, while
-// writing one object into a packfile backend is wasteful. Instead, we define
-// distinct optional capabilities for object-wise writes, pack-wise writes,
-// and compose them against quarantined writes. Where one logical quarantine
-// supports multiple write shapes together, this package also defines a
-// coordinated writer quarantine capability.
-//
-// Concrete implementations generally inherit the contract documented by the
-// interfaces they satisfy. Implementation docs focus on additional guarantees
-// and implementation-specific behavior.
-package objectstore