revwalk.h in rugged-0.23.0b2

- old
+ new

@@ -88,20 +88,22 @@
  * @param walker handle to reset.
  */
 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.
  *
- * 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.
+ * 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.
  * @return 0 or an error code
  */
 GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *id);
@@ -133,10 +135,10 @@
 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
  * output on the revision walk.
  *