summaryrefslogtreecommitdiff
path: root/include/git2/status.h
diff options
context:
space:
mode:
authorUngureanu Marius <marius.ungureanu@xamarin.com>2014-11-07 20:32:50 +0200
committerUngureanu Marius <marius.ungureanu@xamarin.com>2014-11-07 21:34:54 +0200
commit68182085694d76b97eb747960195917df69500c8 (patch)
tree0f535ab30c389eaa54f84168bcf6e85309466e61 /include/git2/status.h
parent4e1b3b3b7186b017223b8302a51289ff92ccba25 (diff)
downloadlibgit2-68182085694d76b97eb747960195917df69500c8.tar.gz
git_status_file now takes an exact path
This function has one output but can match multiple files, which can be unexpected for the user, which would usually path the exact path of the file he wants the status of.
Diffstat (limited to 'include/git2/status.h')
-rw-r--r--include/git2/status.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/git2/status.h b/include/git2/status.h
index 3c86e5d7b..5f211810d 100644
--- a/include/git2/status.h
+++ b/include/git2/status.h
@@ -281,7 +281,8 @@ GIT_EXTERN(int) git_status_foreach_ext(
*
* @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 relative to the repo workdir
+ * @param path The exact path to retrieve status for relative to the
+ * repository working directory
* @return 0 on success, GIT_ENOTFOUND if the file is not found in the HEAD,
* index, and work tree, GIT_EAMBIGUOUS if `path` matches multiple files
* or if it refers to a folder, and -1 on other errors.