From fc2eddf2f0166d491c28481acae529b2ab55f87c Mon Sep 17 00:00:00 2001
From: Runxi Yu
Date: Mon, 23 Mar 2026 06:17:52 +0000
Subject: object/resolve: Add docs to treefs exported functions

---
 object/resolve/treefs_stat.go | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'object/resolve/treefs_stat.go')

diff --git a/object/resolve/treefs_stat.go b/object/resolve/treefs_stat.go
index 5fbecac6..044ba049 100644
--- a/object/resolve/treefs_stat.go
+++ b/object/resolve/treefs_stat.go
@@ -2,6 +2,11 @@ package resolve
 
 import "io/fs"
 
+// Stat returns synthetic file metadata for name.
+//
+// TreeFS metadata reflects Git tree entry mode and blob size where applicable.
+// It does not represent filesystem stat metadata: ModTime is zero, ownership is
+// unavailable, and Sys returns the underlying object.TreeEntry when one exists.
 func (treeFS *TreeFS) Stat(name string) (fs.FileInfo, error) {
 	entry, err := treeFS.resolvePath(treeFSOpStat, name)
 	if err != nil {
-- 
cgit v1.3.1-10-gc9f91