proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-08 22:08:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify docs for git_status_file

Browse Source
This commit is contained in:
Russell Belfer 2013-07-10 15:38:57 -07:00
parent bd679796a5
commit d70ce9bd7a
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/git2/status.h
View File

@ -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,