Merge pull request #3037 from libgit2/cmn/hide-then-push

Handle hide-then-push in the revwalk

1 files changed, 10 insertions, 8 deletions

diff --git a/include/git2/revwalk.h b/include/git2/revwalk.h
index 0a5fdce21..2cc00536e 100644
--- a/include/git2/revwalk.h
+++ b/include/git2/revwalk.h
@@ -90,15 +90,17 @@ GIT_EXTERN(int) git_revwalk_new(git_revwalk **out, git_repository *repo);
 GIT_EXTERN(void) git_revwalk_reset(git_revwalk *walker);
 
 /**
- * Mark a commit to start traversal from.
+ * Add a new root for the traversal
  *
- * The given OID must belong to a committish on the walked
- * repository.
+ * The pushed commit will be marked as one of the roots from which to
+ * start the walk. This commit may not be walked if it or a child is
+ * hidden.
+ *
+ * At least one commit must be pushed onto the walker before a walk
+ * can be started.
  *
- * The given commit will be used as one of the roots
- * when starting the revision walk. At least one commit
- * must be pushed onto the walker before a walk can
- * be started.
+ * The given id must belong to a committish on the walked
+ * repository.
  *
  * @param walk the walker being used for the traversal.
  * @param id the oid of the commit to start from.
@@ -135,7 +137,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 committish on the walked
+ * The given id must belong to a committish on the walked
  * repository.
  *
  * The resolved commit and all its parents will be hidden from the