tree: Document TreeEntryNameCompare

1 files changed, 4 insertions, 0 deletions

diff --git a/obj_tree.go b/obj_tree.go
index 2475b237..99a560f3 100644
--- a/obj_tree.go
+++ b/obj_tree.go
@@ -259,6 +259,10 @@ func (tree *Tree) RemoveEntry(name []byte) error {
 	return ErrNotFound
 }
 
+// TreeEntryNameCompare compares names using Git's tree ordering rules.
+//
+// If an entry or search name is a tree, it is compared as if it has a trailing
+// '/'.
 func TreeEntryNameCompare(entryName []byte, entryMode FileMode, searchName []byte, searchIsTree bool) int {
 	isEntryTree := entryMode == FileModeDir