diff options
Diffstat (limited to 'include/git2')
| -rw-r--r-- | include/git2/index.h | 5 | ||||
| -rw-r--r-- | include/git2/reset.h | 29 |
2 files changed, 29 insertions, 5 deletions
diff --git a/include/git2/index.h b/include/git2/index.h index 9f9d144cf..da95ee9bd 100644 --- a/include/git2/index.h +++ b/include/git2/index.h @@ -400,13 +400,14 @@ GIT_EXTERN(int) git_index_add_bypath(git_index *index, const char *path); GIT_EXTERN(int) git_index_remove_bypath(git_index *index, const char *path); /** - * Find the first index of any entries which point to given + * Find the first position of any entries which point to given * path in the Git index. * * @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 0 if found, < 0 otherwise (GIT_ENOTFOUND) + * @return a zero-based position in the index if found; + * GIT_ENOTFOUND otherwise */ GIT_EXTERN(int) git_index_find(size_t *at_pos, git_index *index, const char *path); diff --git a/include/git2/reset.h b/include/git2/reset.h index 00d25dff0..c7c951942 100644 --- a/include/git2/reset.h +++ b/include/git2/reset.h @@ -28,7 +28,7 @@ typedef enum { * Sets the current head to the specified commit oid and optionally * resets the index and working tree to match. * - * SOFT reset means the head will be moved to the commit. + * SOFT reset means the Head will be moved to the commit. * * MIXED reset will trigger a SOFT reset, plus the index will be replaced * with the content of the commit tree. @@ -41,18 +41,41 @@ typedef enum { * * @param repo Repository where to perform the reset operation. * - * @param target Object to which the Head should be moved to. This object + * @param target Committish to which the Head should be moved to. This object * must belong to the given `repo` and can either be a git_commit or a * git_tag. When a git_tag is being passed, it should be dereferencable * to a git_commit which oid will be used as the target of the branch. * * @param reset_type Kind of reset operation to perform. * - * @return 0 on success or an error code < 0 + * @return 0 on success or an error code */ GIT_EXTERN(int) git_reset( git_repository *repo, git_object *target, git_reset_t reset_type); +/** + * Updates some entries in the index from the target commit tree. + * + * The scope of the updated entries is determined by the paths + * being passed in the `pathspec` parameters. + * + * Passing a NULL `target` will result in removing + * entries in the index matching the provided pathspecs. + * + * @param repo Repository where to perform the reset operation. + * + * @param target The committish which content will be used to reset the content + * of the index. + * + * @param pathspecs List of pathspecs to operate on. + * + * @return 0 on success or an error code < 0 + */ +GIT_EXTERN(int) git_reset_default( + git_repository *repo, + git_object *target, + git_strarray* pathspecs); + /** @} */ GIT_END_DECL #endif |