diff options
author | nulltoken <emeric.fermas@gmail.com> | 2013-01-20 12:08:12 +0100 |
---|---|---|
committer | nulltoken <emeric.fermas@gmail.com> | 2013-02-05 15:47:18 +0100 |
commit | c67ffd4aa0b8e98fc1951d9aeb8f33fec17beede (patch) | |
tree | 50b8c4c0c265d8e4f378c57deeb937f0a394b038 /include/git2 | |
parent | 3cf58e66974f3dcc51ebcf0dc106720f8fe14579 (diff) | |
download | libgit2-c67ffd4aa0b8e98fc1951d9aeb8f33fec17beede.tar.gz |
reset: Enhance documentation
Diffstat (limited to 'include/git2')
-rw-r--r-- | include/git2/reset.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/git2/reset.h b/include/git2/reset.h index 00d25dff0..4c75ae72d 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,14 +41,14 @@ 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); |