utils: update comment in node.go's Hash()

This reflects the lazy hash calculation and the implications of this.
go-git · Jan 10, 2024 · 0eddb86 · 0eddb86
1 parent f7c30f5
commit 0eddb86
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/utils/merkletrie/filesystem/node.go b/utils/merkletrie/filesystem/node.go
@@ -50,6 +50,10 @@ func NewRootNode(
 // difftree algorithm will detect changes in the contents of files and also in
 // their mode.
 //
+// Please note that the hash is calculated on first invocation of Hash(),
+// meaning that it will not update when the underlying file changes
+// between invocations.
+//
 // The hash of a directory is always a 24-bytes slice of zero values
 func (n *node) Hash() []byte {
 	if n.hash == nil {