Unverified Commit 4964aea0 by Patrick Steinhardt Committed by GitHub

Merge pull request #4456 from libgit2/ethomson/treebuilder_docs

docs: git_treebuilder_insert validates entries
parents 98303ea3 346c1b16
...@@ -307,9 +307,10 @@ GIT_EXTERN(const git_tree_entry *) git_treebuilder_get( ...@@ -307,9 +307,10 @@ GIT_EXTERN(const git_tree_entry *) git_treebuilder_get(
* pointer may not be valid past the next operation in this * pointer may not be valid past the next operation in this
* builder. Duplicate the entry if you want to keep it. * builder. Duplicate the entry if you want to keep it.
* *
* No attempt is being made to ensure that the provided oid points * By default the entry that you are inserting will be checked for
* to an existing git object in the object database, nor that the * validity; that it exists in the object database and is of the
* attributes make sense regarding the type of the pointed at object. * 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 out Pointer to store the entry (optional)
* @param bld Tree builder * @param bld Tree builder
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment