diff options
| author | Russell Belfer <rb@github.com> | 2013-07-10 15:38:57 -0700 |
|---|---|---|
| committer | Russell Belfer <rb@github.com> | 2013-07-10 15:38:57 -0700 |
| commit | d70ce9bd7a1acec34b283d3bc92da84fbbf79860 (patch) | |
| tree | d61e49a531d9743645fa18a251dd0a808ecd0e8f /include/git2 | |
| parent | bd679796a57a44270b1f1a4d50652367086f58a3 (diff) | |
| download | libgit2-d70ce9bd7a1acec34b283d3bc92da84fbbf79860.tar.gz | |
Clarify docs for git_status_file
Diffstat (limited to 'include/git2')
| -rw-r--r-- | include/git2/status.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/git2/status.h b/include/git2/status.h index fd0e83104..2f7c06726 100644 --- a/include/git2/status.h +++ b/include/git2/status.h @@ -234,12 +234,12 @@ GIT_EXTERN(int) git_status_foreach_ext( * This is not quite the same as calling `git_status_foreach_ext()` with * the pathspec set to the specified path. * - * @param status_flags The status value for the file + * @param status_flags Output combination of git_status_t values for file * @param repo A repository object - * @param path The file to retrieve status for, rooted at the repo's workdir + * @param path The file to retrieve status for relative to the repo workdir * @return 0 on success, GIT_ENOTFOUND if the file is not found in the HEAD, - * index, and work tree, GIT_EINVALIDPATH if `path` points at a folder, - * GIT_EAMBIGUOUS if "path" matches multiple files, -1 on other error. + * index, and work tree, GIT_EAMBIGUOUS if `path` matches multiple files + * or if it refers to a folder, and -1 on other errors. */ GIT_EXTERN(int) git_status_file( unsigned int *status_flags, |