From 56ac6c0a4b7c4be60642fcda702b9b68c3eb8a75 Mon Sep 17 00:00:00 2001 From: Jacob Wahlgren Date: Sat, 30 Sep 2017 17:23:11 +0200 Subject: graph: document that a commit isn't a descendant of itself --- include/git2/graph.h | 3 +++ 1 file changed, 3 insertions(+) (limited to 'include/git2') diff --git a/include/git2/graph.h b/include/git2/graph.h index c997d8ca9..213ae9777 100644 --- a/include/git2/graph.h +++ b/include/git2/graph.h @@ -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. * + * 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 ancestor a potential ancestor commit. * @return 1 if the given commit is a descendant of the potential ancestor, -- cgit v1.2.1