summaryrefslogtreecommitdiff
path: root/src/git2/repository.h
diff options
context:
space:
mode:
authorVicent Marti <tanoku@gmail.com>2011-02-05 09:29:37 +0200
committerVicent Marti <tanoku@gmail.com>2011-02-05 09:29:37 +0200
commitc836c332f17ff2da8bdf6d18fb3d59eac2586ca9 (patch)
tree724bddb50a0c8f25e59845f9bd0587fb6724457a /src/git2/repository.h
parent4569bfa55a44be3a03cf925df44bf1af0f21ddaa (diff)
downloadlibgit2-c836c332f17ff2da8bdf6d18fb3d59eac2586ca9.tar.gz
Make more methods return error codes
git_revwalk_next now returns an error code when the iteration is over. git_repository_index now returns an error code when the index file could not be opened. Signed-off-by: Vicent Marti <tanoku@gmail.com>
Diffstat (limited to 'src/git2/repository.h')
-rw-r--r--src/git2/repository.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/git2/repository.h b/src/git2/repository.h
index ecf3db99f..ec74305ae 100644
--- a/src/git2/repository.h
+++ b/src/git2/repository.h
@@ -163,11 +163,14 @@ GIT_EXTERN(git_odb *) git_repository_database(git_repository *repo);
/**
* Get the Index file of a Git repository
*
+ * This is a cheap operation; the index is only opened on the first call,
+ * and subsequent calls only retrieve the previous pointer.
+ *
+ * @param index Pointer where to store the index
* @param repo a repository object
- * @return a pointer to the Index object;
- * NULL if the index cannot be opened
+ * @return 0 on success; error code if the index could not be opened
*/
-GIT_EXTERN(git_index *) git_repository_index(git_repository *rpeo);
+GIT_EXTERN(int) git_repository_index(git_index **index, git_repository *repo);
/**
* Create a new in-memory repository object with