aboutsummaryrefslogtreecommitdiff
path: root/object/tree/tree.go
diff options
context:
space:
mode:
Diffstat (limited to 'object/tree/tree.go')
-rw-r--r--object/tree/tree.go8
1 files changed, 5 insertions, 3 deletions
diff --git a/object/tree/tree.go b/object/tree/tree.go
index 31cabd93..d0c7f4f0 100644
--- a/object/tree/tree.go
+++ b/object/tree/tree.go
@@ -1,10 +1,12 @@
// Package tree provides representations, parsers, and serializers for tree objects.
package tree
-// Tree represents a Git tree object.
+// Tree represents a fully materialized Git tree object.
+//
+// Labels: MT-Unsafe.
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.
+ // Use the Tree methods to preserve ordering and copy semantics rather than
+ // modifying the slice directly.
Entries []TreeEntry
}