diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2017-12-31 09:25:42 -0600 |
|---|---|---|
| committer | Edward Thomson <ethomson@edwardthomson.com> | 2017-12-31 09:25:42 -0600 |
| commit | 346c1b169d0c15adeef496e24db6ac9801b4283d (patch) | |
| tree | d02788fe3e1ddb478369ce2a42b05fa78181bfce | |
| parent | d621024508d8264ad63df683dfe1327224eb7143 (diff) | |
| download | libgit2-346c1b169d0c15adeef496e24db6ac9801b4283d.tar.gz | |
docs: git_treebuilder_insert validates entriesethomson/treebuilder_docs
The documentation for `git_treebuilder_insert` erroneously states that
we do not validate that the entry being inserted exists. We do, as of
https://github.com/libgit2/libgit2/pull/3633. Update the documentation
to reflect the new reality.
| -rw-r--r-- | include/git2/tree.h | 7 |
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 |