diff options
| author | Waleed Khan <me@waleedkhan.name> | 2021-06-13 16:42:00 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-13 16:42:00 -0700 |
| commit | 0b3f6da411dd19ffa0b0ca03d5a6752d3d1f9dd2 (patch) | |
| tree | eef34e2a363928e97e958fb094b5c3df7bde249e /include/git2 | |
| parent | 868f4bcb4d3290f4b5320f030fccdf1e7fc8ac8a (diff) | |
| download | libgit2-0b3f6da411dd19ffa0b0ca03d5a6752d3d1f9dd2.tar.gz | |
Fix misleading doc for `git_index_find`
In https://github.com/libgit2/libgit2/pull/5723/files/fc46dc06f52f854f74371682f911f13856c68edb#r540092847, I was confused by the semantics of `git_index_find`. The documentation says both that it returns the output value in `at_pos` and that it returns it directly as an `int`. This is incorrect; the return value is only returned via `at_pos`.
Diffstat (limited to 'include/git2')
| -rw-r--r-- | include/git2/index.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/include/git2/index.h b/include/git2/index.h index 14a132497..dd9227755 100644 --- a/include/git2/index.h +++ b/include/git2/index.h @@ -702,7 +702,7 @@ GIT_EXTERN(int) git_index_update_all( * @param at_pos the address to which the position of the index entry is written (optional) * @param index an existing index object * @param path path to search - * @return a zero-based position in the index if found; GIT_ENOTFOUND otherwise + * @return 0 with valid value in at_pos; an error code otherwise */ GIT_EXTERN(int) git_index_find(size_t *at_pos, git_index *index, const char *path); |