proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-04 13:33:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

README: document our relation to changes in upstream

Browse Source 
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.
This commit is contained in:
Patrick Steinhardt 2017-04-10 12:01:28 +02:00
parent e572b63121
commit 19a04f67cd
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -68,6 +68,16 @@ The library provides:
* descriptive and detailed error messages * descriptive and detailed error messages
* ...and more (over 175 different API calls) * ...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 Optional dependencies
===================== =====================