From d314d1f7e933ca83081eec289aa0cb6e75a7eeac Mon Sep 17 00:00:00 2001
From: Runxi Yu
Date: Sun, 22 Mar 2026 17:33:27 +0000
Subject: objectstore{,/packed}: Document lifetime and integrity behavior

---
 objectstore/packed/read_header.go | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'objectstore/packed/read_header.go')

diff --git a/objectstore/packed/read_header.go b/objectstore/packed/read_header.go
index 5eb37c92..5070c98b 100644
--- a/objectstore/packed/read_header.go
+++ b/objectstore/packed/read_header.go
@@ -6,6 +6,10 @@ import (
 )
 
 // ReadHeader reads an object's type and declared content size.
+//
+// It resolves header metadata only. It does not verify that the full pack entry
+// payload is readable and does not verify any zlib Adler-32 trailer for
+// compressed entry data.
 func (store *Store) ReadHeader(id objectid.ObjectID) (objecttype.Type, int64, error) {
 	loc, err := store.lookup(id)
 	if err != nil {
-- 
cgit v1.3.1-10-gc9f91