summaryrefslogtreecommitdiff
path: root/include/git2/tree.h
diff options
context:
space:
mode:
authorBrian Lopez <seniorlopez@gmail.com>2018-01-10 19:19:34 -0800
committerBrian Lopez <seniorlopez@gmail.com>2018-01-10 19:19:34 -0800
commit5734768b9edaecedaa7b13fed2ce59cb588df7e8 (patch)
tree84a845211a548cef770bbccd32d6d041a2bcea2b /include/git2/tree.h
parentf4f0e7eb0f8280ed6100c37c3af0aa66c31a8f9e (diff)
parentf1323d9c161aeeada190fd9615a8b5a9fb8a7f3e (diff)
downloadlibgit2-5734768b9edaecedaa7b13fed2ce59cb588df7e8.tar.gz
Merge remote-tracking branch 'origin/master' into charliesome/trailer-info
Diffstat (limited to 'include/git2/tree.h')
-rw-r--r--include/git2/tree.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/include/git2/tree.h b/include/git2/tree.h
index 4740b1ffa..1a363c149 100644
--- a/include/git2/tree.h
+++ b/include/git2/tree.h
@@ -307,9 +307,10 @@ GIT_EXTERN(const git_tree_entry *) git_treebuilder_get(
* pointer may not be valid past the next operation in this
* builder. Duplicate the entry if you want to keep it.
*
- * No attempt is being made to ensure that the provided oid points
- * to an existing git object in the object database, nor that the
- * attributes make sense regarding the type of the pointed at object.
+ * By default the entry that you are inserting will be checked for
+ * validity; that it exists in the object database and is of the
+ * correct type. If you do not want this behavior, set the
+ * `GIT_OPT_ENABLE_STRICT_OBJECT_CREATION` library option to false.
*
* @param out Pointer to store the entry (optional)
* @param bld Tree builder