From 346c1b169d0c15adeef496e24db6ac9801b4283d Mon Sep 17 00:00:00 2001 From: Edward Thomson Date: Sun, 31 Dec 2017 09:25:42 -0600 Subject: docs: git_treebuilder_insert validates entries 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. --- include/git2/tree.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'include/git2') 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 -- cgit v1.2.1