Commit 44d9f2cb by Ben Straub

API updates for revwalk.h

parent c9fc4a6f
...@@ -63,11 +63,11 @@ GIT_BEGIN_DECL ...@@ -63,11 +63,11 @@ GIT_BEGIN_DECL
* it is possible to have several revision walkers in * it is possible to have several revision walkers in
* several different threads walking the same repository. * several different threads walking the same repository.
* *
* @param walker pointer to the new revision walker * @param out pointer to the new revision walker
* @param repo the repo to walk through * @param repo the repo to walk through
* @return 0 or an error code * @return 0 or an error code
*/ */
GIT_EXTERN(int) git_revwalk_new(git_revwalk **walker, git_repository *repo); GIT_EXTERN(int) git_revwalk_new(git_revwalk **out, git_repository *repo);
/** /**
* Reset the revision walker for reuse. * Reset the revision walker for reuse.
...@@ -96,10 +96,10 @@ GIT_EXTERN(void) git_revwalk_reset(git_revwalk *walker); ...@@ -96,10 +96,10 @@ GIT_EXTERN(void) git_revwalk_reset(git_revwalk *walker);
* be started. * be started.
* *
* @param walk the walker being used for the traversal. * @param walk the walker being used for the traversal.
* @param oid the oid of the commit to start from. * @param id the oid of the commit to start from.
* @return 0 or an error code * @return 0 or an error code
*/ */
GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *oid); GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *id);
/** /**
* Push matching references * Push matching references
...@@ -134,10 +134,10 @@ GIT_EXTERN(int) git_revwalk_push_head(git_revwalk *walk); ...@@ -134,10 +134,10 @@ GIT_EXTERN(int) git_revwalk_push_head(git_revwalk *walk);
* output on the revision walk. * output on the revision walk.
* *
* @param walk the walker being used for the traversal. * @param walk the walker being used for the traversal.
* @param oid the oid of commit that will be ignored during the traversal * @param commit_id the oid of commit that will be ignored during the traversal
* @return 0 or an error code * @return 0 or an error code
*/ */
GIT_EXTERN(int) git_revwalk_hide(git_revwalk *walk, const git_oid *oid); GIT_EXTERN(int) git_revwalk_hide(git_revwalk *walk, const git_oid *commit_id);
/** /**
* Hide matching references. * Hide matching references.
...@@ -198,12 +198,12 @@ GIT_EXTERN(int) git_revwalk_hide_ref(git_revwalk *walk, const char *refname); ...@@ -198,12 +198,12 @@ GIT_EXTERN(int) git_revwalk_hide_ref(git_revwalk *walk, const char *refname);
* *
* The revision walker is reset when the walk is over. * The revision walker is reset when the walk is over.
* *
* @param oid Pointer where to store the oid of the next commit * @param out Pointer where to store the oid of the next commit
* @param walk the walker to pop the commit from. * @param walk the walker to pop the commit from.
* @return 0 if the next commit was found; * @return 0 if the next commit was found;
* GIT_ITEROVER if there are no commits left to iterate * GIT_ITEROVER if there are no commits left to iterate
*/ */
GIT_EXTERN(int) git_revwalk_next(git_oid *oid, git_revwalk *walk); GIT_EXTERN(int) git_revwalk_next(git_oid *out, git_revwalk *walk);
/** /**
* Change the sorting mode when iterating through the * Change the sorting mode when iterating through the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment