Skip to content

Commit 19a04f6

Browse files
committed
README: document our relation to changes in upstream
libgit2 is a mere consumer of changes which are trickling down from the upstream git.git project. This commit documents the ramifications caused by this relation.
1 parent e572b63 commit 19a04f6

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,16 @@ The library provides:
6868
* descriptive and detailed error messages
6969
* ...and more (over 175 different API calls)
7070

71+
As libgit2 is purely a consumer of the Git system, we have to
72+
adjust to changes made upstream. This has two major consequences:
73+
74+
* Some changes may require us to change provided interfaces. While we try to
75+
implement functions in a generic way so that no future changes are required,
76+
we cannot promise a completely stable API.
77+
* As we have to keep up with changes in behavior made upstream, we may lag
78+
behind in some areas. We usually to document these incompatibilities in our
79+
issue tracker with the label "git change".
80+
7181
Optional dependencies
7282
=====================
7383

0 commit comments

Comments
 (0)