Merge pull request libgit2#4456 from libgit2/ethomson/treebuilder_docs

pks-t · web-flow · commit 4964aea07e22 · 2018-01-03T11:28:26.000Z
docs: git_treebuilder_insert validates entries
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -307,9 +307,10 @@ GIT_EXTERN(const git_tree_entry *) git_treebuilder_get(`
`307`	`307`	`* pointer may not be valid past the next operation in this`
`308`	`308`	`* builder. Duplicate the entry if you want to keep it.`
`309`	`309`	`*`
`310`		`- * No attempt is being made to ensure that the provided oid points`
`311`		`- * to an existing git object in the object database, nor that the`
`312`		`- * attributes make sense regarding the type of the pointed at object.`
	`310`	`+ * By default the entry that you are inserting will be checked for`
	`311`	`+ * validity; that it exists in the object database and is of the`
	`312`	`+ * correct type. If you do not want this behavior, set the`
	`313`	+ * `GIT_OPT_ENABLE_STRICT_OBJECT_CREATION` library option to false.
`313`	`314`	`*`
`314`	`315`	`* @param out Pointer to store the entry (optional)`
`315`	`316`	`* @param bld Tree builder`