tree: Fix lookups by entry name

1 files changed, 6 insertions, 0 deletions

diff --git a/include/git2/tree.h b/include/git2/tree.h
index 8d638f723..e30595016 100644
--- a/include/git2/tree.h
+++ b/include/git2/tree.h
@@ -88,6 +88,9 @@ GIT_EXTERN(unsigned int) git_tree_entrycount(git_tree *tree);
 /**
  * Lookup a tree entry by its filename
  *
+ * Note that if the entry in the tree is a folder instead of
+ * a standard file, the given name must be ended with a slash.
+ *
  * @param tree a previously loaded tree.
  * @param filename the filename of the desired entry
  * @return the tree entry; NULL if not found
@@ -203,6 +206,9 @@ GIT_EXTERN(void) git_treebuilder_free(git_treebuilder *bld);
 /**
  * Get an entry from the builder from its filename
  *
+ * Note that if the entry in the tree is a folder instead of
+ * a standard file, the given name must be ended with a slash.
+ *
  * The returned entry is owned by the builder and should
  * not be freed manually.
  *