Commit d70ce9bd by Russell Belfer

Clarify docs for git_status_file

parent bd679796
...@@ -234,12 +234,12 @@ GIT_EXTERN(int) git_status_foreach_ext( ...@@ -234,12 +234,12 @@ GIT_EXTERN(int) git_status_foreach_ext(
* This is not quite the same as calling `git_status_foreach_ext()` with * This is not quite the same as calling `git_status_foreach_ext()` with
* the pathspec set to the specified path. * 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 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, * @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, * index, and work tree, GIT_EAMBIGUOUS if `path` matches multiple files
* GIT_EAMBIGUOUS if "path" matches multiple files, -1 on other error. * or if it refers to a folder, and -1 on other errors.
*/ */
GIT_EXTERN(int) git_status_file( GIT_EXTERN(int) git_status_file(
unsigned int *status_flags, unsigned int *status_flags,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment