annotated_commit.h in rugged-0.23.0b1

- old
+ new

@@ -42,11 +42,11 @@
  *
  * @param out pointer to store the git_annotated_commit result in
  * @param repo repository that contains the given commit
  * @param branch_name name of the (remote) branch
  * @param remote_url url of the remote
- * @param oid the commit object id of the remote branch
+ * @param id the commit object id of the remote branch
  * @return 0 on success or error code
  */
 GIT_EXTERN(int) git_annotated_commit_from_fetchhead(
 	git_annotated_commit **out,
 	git_repository *repo,
@@ -76,21 +76,38 @@
 	git_annotated_commit **out,
 	git_repository *repo,
 	const git_oid *id);
 
 /**
+ * Creates a `git_annotated_comit` from a revision string.
+ *
+ * See `man gitrevisions`, or
+ * http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for
+ * information on the syntax accepted.
+ *
+ * @param out pointer to store the git_annotated_commit result in
+ * @param repo repository that contains the given commit
+ * @param revspec the extended sha syntax string to use to lookup the commit
+ * @return 0 on success or error code
+ */
+GIT_EXTERN(int) git_annotated_commit_from_revspec(
+	git_annotated_commit **out,
+	git_repository *repo,
+	const char *revspec);
+
+/**
  * Gets the commit ID that the given `git_annotated_commit` refers to.
  *
- * @param head the given annotated commit
+ * @param commit the given annotated commit
  * @return commit id
  */
 GIT_EXTERN(const git_oid *) git_annotated_commit_id(
 	const git_annotated_commit *commit);
 
 /**
  * Frees a `git_annotated_commit`.
  *
- * @param annotated_commit annotated commit to free
+ * @param commit annotated commit to free
  */
 GIT_EXTERN(void) git_annotated_commit_free(
 	git_annotated_commit *commit);
 
 /** @} */