diff options
| author | Jacob Wahlgren <jacob.wahlgren@gmail.com> | 2017-09-30 17:23:11 +0200 |
|---|---|---|
| committer | Jacob Wahlgren <jacob.wahlgren@gmail.com> | 2017-10-06 14:33:16 +0200 |
| commit | 56ac6c0a4b7c4be60642fcda702b9b68c3eb8a75 (patch) | |
| tree | c3b79e6a285c6e0dd6c0a19c4a6ef4f3542bd3cb /include/git2/graph.h | |
| parent | c7c5f2c4ecc727ac555f51bd20353f7f3ae9c07a (diff) | |
| download | libgit2-56ac6c0a4b7c4be60642fcda702b9b68c3eb8a75.tar.gz | |
graph: document that a commit isn't a descendant of itself
Diffstat (limited to 'include/git2/graph.h')
| -rw-r--r-- | include/git2/graph.h | 3 |
1 files changed, 3 insertions, 0 deletions
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, |