summaryrefslogtreecommitdiff
path: root/include/git2/revwalk.h
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2014-02-01 12:51:36 +0100
committerCarlos Martín Nieto <cmn@dwim.me>2014-02-05 12:16:37 +0100
commitf61272e04727716ad09bb57e4ffa9ce4be09dc55 (patch)
treeec760d396b940835c8023bb2bafd1cc3d201ba6c /include/git2/revwalk.h
parent7369ea8075fa112bbd4c13f06eeedeb2a4e47153 (diff)
downloadlibgit2-f61272e04727716ad09bb57e4ffa9ce4be09dc55.tar.gz
revwalk: accept committish objects
Let the user push committish objects and peel them to figure out which commit to push to our queue. This is for convenience and for allowing uses of git_revwalk_push_glob(w, "tags") with annotated tags.
Diffstat (limited to 'include/git2/revwalk.h')
-rw-r--r--include/git2/revwalk.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/git2/revwalk.h b/include/git2/revwalk.h
index c59b79938..4eac8d43c 100644
--- a/include/git2/revwalk.h
+++ b/include/git2/revwalk.h
@@ -87,7 +87,7 @@ GIT_EXTERN(void) git_revwalk_reset(git_revwalk *walker);
/**
* Mark a commit to start traversal from.
*
- * The given OID must belong to a commit on the walked
+ * The given OID must belong to a committish on the walked
* repository.
*
* The given commit will be used as one of the roots
@@ -127,7 +127,7 @@ GIT_EXTERN(int) git_revwalk_push_head(git_revwalk *walk);
/**
* Mark a commit (and its ancestors) uninteresting for the output.
*
- * The given OID must belong to a commit on the walked
+ * The given OID must belong to a committish on the walked
* repository.
*
* The resolved commit and all its parents will be hidden from the
@@ -166,7 +166,7 @@ GIT_EXTERN(int) git_revwalk_hide_head(git_revwalk *walk);
/**
* Push the OID pointed to by a reference
*
- * The reference must point to a commit.
+ * The reference must point to a committish.
*
* @param walk the walker being used for the traversal
* @param refname the reference to push
@@ -177,7 +177,7 @@ GIT_EXTERN(int) git_revwalk_push_ref(git_revwalk *walk, const char *refname);
/**
* Hide the OID pointed to by a reference
*
- * The reference must point to a commit.
+ * The reference must point to a committish.
*
* @param walk the walker being used for the traversal
* @param refname the reference to hide