shithub: furgit

Download patch

ref: 86a9cc87c9d3c42035b6c526ec918c391024424d
parent: 9cc0a032458dc532e63f1e894e9dd266c80f175f
author: Runxi Yu <me@runxiyu.org>
date: Sat Feb 21 08:05:11 EST 2026

*: Update doc-comments

binary files a/STRUCTURE b/STRUCTURE differ
--- a/config/config.go
+++ b/config/config.go
@@ -1,4 +1,4 @@
-// Package config provides routines to parse Git configuration files.
+// Package config provides configuration parsing.
 package config
 
 import (
--- /dev/null
+++ b/internal/cache/cache.go
@@ -1,0 +1,2 @@
+// Package cache encapsulates cache-providing subpackages for direct use.
+package cache
--- a/internal/cache/lru/lru.go
+++ b/internal/cache/lru/lru.go
@@ -1,4 +1,4 @@
-// Package lru provides a weighted least-recently-used cache.
+// Package lru provides a size-cost bounded LRU cache.
 package lru
 
 import "container/list"
--- /dev/null
+++ b/internal/internal.go
@@ -1,0 +1,3 @@
+// Package internal provides private packages and helpers.
+package internal
+
--- a/object/object.go
+++ b/object/object.go
@@ -1,4 +1,5 @@
-// Package object provides Git object models and codecs.
+// Package object parses and serializes objects such as blob, tree, commit, and
+// tag.
 package object
 
 import "codeberg.org/lindenii/furgit/objecttype"
--- a/objectid/objectid.go
+++ b/objectid/objectid.go
@@ -1,4 +1,4 @@
-// Package objectid provides object ID and algorithm primitives for Git objects.
+// Package objectid provides utilities around object IDs and hash algorithms.
 package objectid
 
 import (
--- a/objectstore/chain/chain.go
+++ b/objectstore/chain/chain.go
@@ -1,4 +1,5 @@
-// Package chain provides an ordered object database chain implementation.
+// Package chain provides a wrapper object storage backend to query a chain of
+// backends.
 package chain
 
 import (
--- a/objectstore/loose/store.go
+++ b/objectstore/loose/store.go
@@ -1,4 +1,4 @@
-// Package loose provides loose-object reads from a Git objects directory.
+// Package loose provides a loose object backend (objects/XX/YYYYY..).
 package loose
 
 import (
--- a/objectstore/objectstore.go
+++ b/objectstore/objectstore.go
@@ -1,4 +1,4 @@
-// Package objectstore provides storage interfaces for Git objects.
+// Package objectstore provides interfaces for object storage backends.
 package objectstore
 
 import (
--- a/objectstore/packed/store.go
+++ b/objectstore/packed/store.go
@@ -1,4 +1,4 @@
-// Package packed provides read access to packed Git objects from objects/pack.
+// Package packed provides packfile reading and associated indexes.
 package packed
 
 import (
--- a/objecttype/objecttype.go
+++ b/objecttype/objecttype.go
@@ -1,4 +1,4 @@
-// Package objecttype defines Git object type identifiers.
+// Package objecttype provides object type constants and names.
 package objecttype
 
 // Type mirrors Git object type tags in packfiles.
--- a/ref/ref.go
+++ b/ref/ref.go
@@ -1,4 +1,4 @@
-// Package ref provides Git reference models.
+// Package ref provides general, detached, and symbolic references.
 package ref
 
 import "codeberg.org/lindenii/furgit/objectid"
--- a/refstore/chain/chain.go
+++ b/refstore/chain/chain.go
@@ -1,4 +1,5 @@
-// Package chain provides an ordered reference store chain implementation.
+// Package chain provides a wrapper reference storage backend to query a chain
+// of backends.
 package chain
 
 import (
--- a/refstore/loose/store.go
+++ b/refstore/loose/store.go
@@ -1,4 +1,4 @@
-// Package loose provides read access to loose Git references.
+// Package loose provides a loose ref backend (refs/... as a directory tree).
 package loose
 
 import (
--- a/refstore/packed/store.go
+++ b/refstore/packed/store.go
@@ -1,4 +1,4 @@
-// Package packed provides read access to packed Git references.
+// Package packed provides a packed refs backend.
 package packed
 
 import (
--- a/refstore/reftable/store.go
+++ b/refstore/reftable/store.go
@@ -1,5 +1,4 @@
-// Package reftable provides read access to Git reftable reference storage.
-// This store is experimental, has many issues, and should not be used in any serious capacity for now.
+// Package reftable provides an experimental reftable backend.
 package reftable
 
 import (
--