From 43e343908408ed641785b58896445e9912216f3e Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Thu, 2 Apr 2026 08:03:02 +0000 Subject: object/store: Document package --- object/store/doc.go | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 object/store/doc.go diff --git a/object/store/doc.go b/object/store/doc.go new file mode 100644 index 00000000..5dedd7a1 --- /dev/null +++ b/object/store/doc.go @@ -0,0 +1,13 @@ +// Package store 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. +package store -- cgit v1.3.1-10-gc9f91