diff options
| author |  Runxi Yu | 2026-03-28 16:36:23 +0000 |
|---|---|---|
| committer | Runxi Yu | 2026-03-28 16:36:23 +0000 |
| commit | 6d3a1ad712d2f0affe06b75b1f2fe05e84e2f8ab (patch) | |
| tree | 303d8bafa0ac5992665c6e93502b24e954e877a5 | |
| parent | object/tree: Update docs (diff) | |
| signature | No signature | |
object/{blob,commit,tag}: Update docs
| -rw-r--r-- | object/blob/blob.go | 7 | ||||
| -rw-r--r-- | object/commit/commit.go | 4 | ||||
| -rw-r--r-- | object/tag/tag.go | 4 |
3 files changed, 11 insertions, 4 deletions
diff --git a/object/blob/blob.go b/object/blob/blob.go index 4ec98fb0..71c1f6f8 100644 --- a/object/blob/blob.go +++ b/object/blob/blob.go @@ -3,9 +3,12 @@ package blob // Blob represents a Git blob object. // -// This Blob object is fully materialized in memory. -// Consider using objectstore/Store.ReadReaderContent, +// Blob is fully materialized in memory. +// +// Consider using objectstore.ReadingStore.ReadReaderContent, // or appropriate streaming write APIs. +// +// Labels: MT-Unsafe. type Blob struct { Data []byte } diff --git a/object/commit/commit.go b/object/commit/commit.go index e2e087f5..df0e0aca 100644 --- a/object/commit/commit.go +++ b/object/commit/commit.go @@ -6,7 +6,9 @@ import ( objectsignature "codeberg.org/lindenii/furgit/object/signature" ) -// Commit represents a Git commit object. +// Commit represents a fully materialized Git commit object. +// +// Labels: MT-Unsafe. type Commit struct { Tree objectid.ObjectID Parents []objectid.ObjectID diff --git a/object/tag/tag.go b/object/tag/tag.go index 4301557e..60c3a67a 100644 --- a/object/tag/tag.go +++ b/object/tag/tag.go @@ -7,7 +7,9 @@ import ( objecttype "codeberg.org/lindenii/furgit/object/type" ) -// Tag represents a Git annotated tag object. +// Tag represents a fully materialized Git annotated tag object. +// +// Labels: MT-Unsafe. type Tag struct { Target objectid.ObjectID TargetType objecttype.Type |