Skip to content

G
git2
Commit 56ac6c0a by Jacob Wahlgren
Options

graph: document that a commit isn't a descendant of itself

parent c7c5f2c4
Showing with 3 additions and 0 deletions
include/git2/graph.h
...@@ -40,6 +40,9 @@ GIT_EXTERN(int) git_graph_ahead_behind(size_t *ahead, size_t *behind, git_reposi ...@@ -40,6 +40,9 @@ GIT_EXTERN(int) git_graph_ahead_behind(size_t *ahead, size_t *behind, git_reposi
/** /**
* Determine if a commit is the descendant of another commit. * Determine if a commit is the descendant of another commit.
* *
* Note that a commit is not considered a descendant of itself, in contrast
* to `git merge-base --is-ancestor`.
*
* @param commit a previously loaded commit. * @param commit a previously loaded commit.
* @param ancestor a potential ancestor commit. * @param ancestor a potential ancestor commit.
* @return 1 if the given commit is a descendant of the potential ancestor, * @return 1 if the given commit is a descendant of the potential ancestor,
......
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