summaryrefslogtreecommitdiff
path: root/include/git2/status.h
diff options
context:
space:
mode:
authornulltoken <emeric.fermas@gmail.com>2011-09-02 13:44:42 +0200
committerVicent Marti <tanoku@gmail.com>2011-09-15 01:14:36 +0200
commit56453d346864e312ec138626a3fc920c39890f0d (patch)
tree3653456e1c93d7e41e7688a306d3f519167e180b /include/git2/status.h
parent3601c4bfce3df04ebfc8668e5db531ded39280a9 (diff)
downloadlibgit2-56453d346864e312ec138626a3fc920c39890f0d.tar.gz
status: enhance determination of status for a single file
- fix retrieval of a file status when working against a newly initialized repository - reduce memory pressure - prevents a directory from being tested
Diffstat (limited to 'include/git2/status.h')
-rw-r--r--include/git2/status.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/git2/status.h b/include/git2/status.h
index fead43b02..622d9535d 100644
--- a/include/git2/status.h
+++ b/include/git2/status.h
@@ -70,7 +70,9 @@ GIT_EXTERN(int) git_status_foreach(git_repository *repo, int (*callback)(const c
* @param status_flags the status value
* @param repo a repository object
* @param path the file to retrieve status for, rooted at the repo's workdir
- * @return GIT_SUCCESS or an error code
+ * @return GIT_EINVALIDPATH when `path` points at a folder, GIT_ENOTFOUND when
+ * the file doesn't exist in any of HEAD, the index or the worktree,
+ * GIT_SUCCESS otherwise
*/
GIT_EXTERN(int) git_status_file(unsigned int *status_flags, git_repository *repo, const char *path);