diff options
author | Vicent Marti <tanoku@gmail.com> | 2011-04-04 12:14:03 +0300 |
---|---|---|
committer | Vicent Marti <tanoku@gmail.com> | 2011-04-04 12:14:43 +0300 |
commit | 29e1789b34d9aa5e486ca12937899a43f2e2407b (patch) | |
tree | 21d5bc9822893d3b9ea52bb14e1f6ae6cd8af1de /include/git2/tree.h | |
parent | 47d8ec56e917adda2e336c29420f527fca733866 (diff) | |
download | libgit2-29e1789b34d9aa5e486ca12937899a43f2e2407b.tar.gz |
Fix the git_tree_write implementation
Diffstat (limited to 'include/git2/tree.h')
-rw-r--r-- | include/git2/tree.h | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/include/git2/tree.h b/include/git2/tree.h index bd1f9707..60150b30 100644 --- a/include/git2/tree.h +++ b/include/git2/tree.h @@ -134,21 +134,27 @@ GIT_EXTERN(const git_oid *) git_tree_entry_id(git_tree_entry *entry); * @param object pointer to the converted object * @param repo repository where to lookup the pointed object * @param entry a tree entry - * @return a reference to the pointed object in the repository + * @return 0 on success; error code otherwise */ GIT_EXTERN(int) git_tree_entry_2object(git_object **object_out, git_repository *repo, git_tree_entry *entry); /** - * Create tree by scanning the index file. - * - * @param object identity for the tree - * @param repository where to lookup for object db - * @param base directory path - * @param path length for base - * @param index entry offset to start scan - * @return number of items added to the tree + * Write a tree to the ODB from the index file + * + * This method will scan the index and write a representation + * of its current state back to disk; it recursively creates + * tree objects for each of the subtrees stored in the index, + * but only returns the OID of the root tree. This is the OID + * that can be used e.g. to create a commit. + * + * The index instance cannot be bare, and needs to be associated + * to an existing repository. + * + * @param oid Pointer where to store the written tree + * @param index Index to write + * @return 0 on success; error code otherwise */ -GIT_EXTERN(int) git_tree_create(git_oid *oid, git_repository *repo, const char *base, int baselen, int entry_no); +GIT_EXTERN(int) git_tree_create_fromindex(git_oid *oid, git_index *index); /** @} */ GIT_END_DECL |