summaryrefslogtreecommitdiff
path: root/include/git2/tree.h
diff options
context:
space:
mode:
authornulltoken <emeric.fermas@gmail.com>2012-08-17 11:21:49 +0200
committernulltoken <emeric.fermas@gmail.com>2012-08-19 14:11:59 +0200
commit66439b0b1a9e9a1145400bf905d427f404c64ea7 (patch)
tree20c386c1b37ed47c0833cab891e9ef496570dca8 /include/git2/tree.h
parenta7e3bd9b0fe223a8d7773b7fa9cb7fd767e1de5e (diff)
downloadlibgit2-66439b0b1a9e9a1145400bf905d427f404c64ea7.tar.gz
treebuilder: enhance attributes handling on insertion
Diffstat (limited to 'include/git2/tree.h')
-rw-r--r--include/git2/tree.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/include/git2/tree.h b/include/git2/tree.h
index 85407d7a..29aedacc 100644
--- a/include/git2/tree.h
+++ b/include/git2/tree.h
@@ -263,11 +263,17 @@ GIT_EXTERN(const git_tree_entry *) git_treebuilder_get(git_treebuilder *bld, con
* The optional pointer `entry_out` can be used to retrieve a
* pointer to the newly created/updated entry.
*
+ * 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.
+ *
* @param entry_out Pointer to store the entry (optional)
* @param bld Tree builder
* @param filename Filename of the entry
* @param id SHA1 oid of the entry
- * @param attributes Folder attributes of the entry
+ * @param attributes Folder attributes of the entry. This parameter must
+ * be valued with one of the following entries: 0040000, 0100644,
+ * 0100755, 0120000 or 0160000.
* @return 0 or an error code
*/
GIT_EXTERN(int) git_treebuilder_insert(