diff options
Diffstat (limited to 'include/git2/status.h')
| -rw-r--r-- | include/git2/status.h | 4 |
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); |