aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-03-29 18:38:47 +0000
committerGravatar Runxi Yu2026-03-29 18:39:29 +0000
commit02c78ff5025297b18f96e6741c2df38b7fe8849d (patch)
treefd23e80240b58090a96a18fe12e5665de713e48b
parentROADMAP: Updates (diff)
signatureNo signature
*: Update docs v0.1.151
-rw-r--r--network/doc.go5
-rw-r--r--object/commit/commit.go7
-rw-r--r--object/signed/doc.go7
-rw-r--r--object/tag/tag.go7
4 files changed, 22 insertions, 4 deletions
diff --git a/network/doc.go b/network/doc.go
index 40ec0697..d964997b 100644
--- 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
diff --git a/object/commit/commit.go b/object/commit/commit.go
index df0e0aca..0f7649e1 100644
--- 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 (
diff --git a/object/signed/doc.go b/object/signed/doc.go
index 9953a3d3..fb6fc3f8 100644
--- 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
diff --git a/object/tag/tag.go b/object/tag/tag.go
index 60c3a67a..e01f8ac9 100644
--- 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 (