summaryrefslogtreecommitdiff
path: root/include/git2/reset.h
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2015-03-06 23:51:40 +0100
committerCarlos Martín Nieto <cmn@dwim.me>2015-03-16 16:57:30 +0100
commit62d38a1ddb8081f8b46e7ff6e21ebeb0014162d6 (patch)
tree9db11e71533062a0ec6b55e1e767235469390ec0 /include/git2/reset.h
parentd675982a15388d8c413acda139b4662062cf3286 (diff)
downloadlibgit2-62d38a1ddb8081f8b46e7ff6e21ebeb0014162d6.tar.gz
Add annotated commit versions of reflog-modifying functions
We do not always want to put the id directly into the reflog, but we want to speicfy what a user typed. For this use-case we provide annotated version of a few functions which let the caller specify what user-friendly name was used when asking for the operation.
Diffstat (limited to 'include/git2/reset.h')
-rw-r--r--include/git2/reset.h18
1 files changed, 18 insertions, 0 deletions
diff --git a/include/git2/reset.h b/include/git2/reset.h
index 93ac0b29c..c03dbed8c 100644
--- a/include/git2/reset.h
+++ b/include/git2/reset.h
@@ -65,6 +65,24 @@ GIT_EXTERN(int) git_reset(
git_checkout_options *checkout_opts);
/**
+ * Sets the current head to the specified commit oid and optionally
+ * resets the index and working tree to match.
+ *
+ * This behaves like `git_reset()` but takes an annotated commit,
+ * which lets you specify which extended sha syntax string was
+ * specified by a user, allowing for more exact reflog messages.
+ *
+ * See the documentation for `git_reset()`.
+ *
+ * @see git_reset
+ */
+GIT_EXTERN(int) git_reset_from_annotated(
+ git_repository *repo,
+ git_annotated_commit *commit,
+ git_reset_t reset_type,
+ git_checkout_options *checkout_opts);
+
+/**
* Updates some entries in the index from the target commit tree.
*
* The scope of the updated entries is determined by the paths