Commit 824cb2d5e587f13b596933b991c7d8568422946a
2012-11-20T12:13:52
Updates to reset.h
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
diff --git a/include/git2/reset.h b/include/git2/reset.h
index cdcfb76..b5fc4a6 100644
--- a/include/git2/reset.h
+++ b/include/git2/reset.h
@@ -16,16 +16,26 @@
GIT_BEGIN_DECL
/**
+ * Kinds of reset operation
+ */
+typedef enum {
+ GIT_RESET_SOFT = 1, /** Move the head to the given commit */
+ GIT_RESET_MIXED = 2, /** SOFT plus reset index to the commit */
+ GIT_RESET_HARD = 3, /** MIXED plus changes in working tree discarded */
+} git_reset_t;
+
+/**
* Sets the current head to the specified commit oid and optionally
* resets the index and working tree to match.
*
- * When specifying a Soft kind of reset, the head will be moved to the commit.
+ * SOFT reset means the head will be moved to the commit.
*
- * Specifying a Mixed kind of reset will trigger a Soft reset and the index will
- * be replaced with the content of the commit tree.
+ * MIXED reset will trigger a SOFT reset, plus the index will be replaced
+ * with the content of the commit tree.
*
- * Specifying a Hard kind of reset will trigger a Mixed reset and the working
- * directory will be replaced with the content of the index.
+ * HARD reset will trigger a MIXED reset and the working directory will be
+ * replaced with the content of the index. (Untracked and ignored files
+ * will be left alone, however.)
*
* TODO: Implement remaining kinds of resets.
*
@@ -38,9 +48,10 @@ GIT_BEGIN_DECL
*
* @param reset_type Kind of reset operation to perform.
*
- * @return GIT_SUCCESS or an error code
+ * @return 0 on success or an error code < 0
*/
-GIT_EXTERN(int) git_reset(git_repository *repo, git_object *target, git_reset_type reset_type);
+GIT_EXTERN(int) git_reset(
+ git_repository *repo, git_object *target, git_reset_t reset_type);
/** @} */
GIT_END_DECL
diff --git a/include/git2/types.h b/include/git2/types.h
index 58cbaec..2562964 100644
--- a/include/git2/types.h
+++ b/include/git2/types.h
@@ -175,13 +175,6 @@ typedef enum {
GIT_BRANCH_REMOTE = 2,
} git_branch_t;
-/** Kinds of reset operation. */
-typedef enum {
- GIT_RESET_SOFT = 1,
- GIT_RESET_MIXED = 2,
- GIT_RESET_HARD = 3,
-} git_reset_type;
-
/** Valid modes for index and tree entries. */
typedef enum {
GIT_FILEMODE_NEW = 0000000,
diff --git a/src/reset.c b/src/reset.c
index 928a2bc..d410a88 100644
--- a/src/reset.c
+++ b/src/reset.c
@@ -63,7 +63,7 @@ cleanup:
int git_reset(
git_repository *repo,
git_object *target,
- git_reset_type reset_type)
+ git_reset_t reset_type)
{
git_object *commit = NULL;
git_index *index = NULL;