From 19a04f67cdd0c9c518b99ab24b239b60e8d1209b Mon Sep 17 00:00:00 2001 From: Patrick Steinhardt Date: Mon, 10 Apr 2017 12:01:28 +0200 Subject: [PATCH] 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. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index c3fb27c98..472261cef 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 =====================