shithub: furgit

Download patch

ref: 02c78ff5025297b18f96e6741c2df38b7fe8849d
parent: dae791f0b988a8bbf76b4a5d250e98070412c2da
author: Runxi Yu <runxiyu@umich.edu>
date: Sun Mar 29 14:38:47 EDT 2026

*: Update docs

--- a/network/doc.go
+++ b/network/doc.go
@@ -1,2 +1,5 @@
-// Package network encapsulates network-oriented git operations.
+// Package network encapsulates network-facing Git packages.
+//
+// These packages implement wire formats, protocol framing, and application
+// services built on top of them.
 package network
--- a/object/commit/commit.go
+++ b/object/commit/commit.go
@@ -1,4 +1,9 @@
-// Package commit provides representations, parsers, and serializers for commit objects.
+// Package commit provides parsed commit objects and commit serialization.
+//
+// It parses commits into ordinary Go values for reading and construction. It
+// does not preserve the exact original byte layout needed for signature
+// verification; callers that need signature-verification payload fidelity
+// should use [codeberg.org/lindenii/furgit/object/signed/commit].
 package commit
 
 import (
--- a/object/signed/doc.go
+++ b/object/signed/doc.go
@@ -1,2 +1,7 @@
-// Package signed encapsulates some routines to process signed commits and tags.
+// Package signed encapsulates raw signed-object processing.
+//
+// Its subpackages extract verification payloads and embedded signatures from
+// raw commit and tag object bodies, without depending on the parsed
+// object models in [codeberg.org/lindenii/furgit/object/commit] and
+// [codeberg.org/lindenii/furgit/object/tag].
 package signed
--- a/object/tag/tag.go
+++ b/object/tag/tag.go
@@ -1,4 +1,9 @@
-// Package tag provides representations, parsers, and serializers for tag objects.
+// Package tag provides parsed annotated tag objects and tag serialization.
+//
+// It parses annotated tags into ordinary Go values for reading and
+// construction. It does not preserve the exact original byte layout needed for
+// signature verification; callers that need signature-verification payload
+// fidelity should use [codeberg.org/lindenii/furgit/object/signed/tag].
 package tag
 
 import (
--