Commit 1262963adddf267c4f1abf08d16d45256a61b325

Edward Thomson 2017-04-11T19:10:28

Merge pull request #4198 from pks-t/pks/git-compat README: document our relation to changes in upstream

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
diff --git a/README.md b/README.md
index c3fb27c..472261c 100644
--- a/README.md
+++ b/README.md
@@ -68,6 +68,16 @@ The library provides:
 * descriptive and detailed error messages
 * ...and more (over 175 different API calls)
 
+As libgit2 is purely a consumer of the Git system, we have to
+adjust to changes made upstream. This has two major consequences:
+
+* Some changes may require us to change provided interfaces. While we try to
+  implement functions in a generic way so that no future changes are required,
+  we cannot promise a completely stable API.
+* As we have to keep up with changes in behavior made upstream, we may lag
+  behind in some areas. We usually to document these incompatibilities in our
+  issue tracker with the label "git change".
+
 Optional dependencies
 =====================