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

reset: Enhance documentation

Browse Source
This commit is contained in:
nulltoken 2013-01-20 12:08:12 +01:00
parent 3cf58e6697
commit c67ffd4aa0
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/git2/reset.h
View File

@ -28,7 +28,7 @@ typedef enum {
* Sets the current head to the specified commit oid and optionally * Sets the current head to the specified commit oid and optionally
* resets the index and working tree to match. * 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 * MIXED reset will trigger a SOFT reset, plus the index will be replaced
* with the content of the commit tree. * with the content of the commit tree.
@ -41,14 +41,14 @@ typedef enum {
* *
* @param repo Repository where to perform the reset operation. * @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 * 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 * 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. * to a git_commit which oid will be used as the target of the branch.
* *
* @param reset_type Kind of reset operation to perform. * @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_EXTERN(int) git_reset(
git_repository *repo, git_object *target, git_reset_t reset_type); git_repository *repo, git_object *target, git_reset_t reset_type);