tree: Document that tree entries should be sorted

1 files changed, 3 insertions, 0 deletions

diff --git a/object/tree/tree.go b/object/tree/tree.go
index 3ea6f1ee..31cabd93 100644
--- a/object/tree/tree.go
+++ b/object/tree/tree.go
@@ -3,5 +3,8 @@ package tree
 
 // Tree represents a Git tree object.
 type Tree struct {
+	// Entries must be sorted by TreeEntryNameCompare.
+	// You are strongly advised to use the methods for manipulation
+	// rather than modifying the slice yourself.
 	Entries []TreeEntry
 }