saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #29095 from terminalmage/pygit2-warning

Browse source 
Add warning about pygit2 API instability
This commit is contained in:
Nicole Thomas 2015-11-21 08:38:59 -07:00
commit 4ff54c6429
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/topics/tutorials/gitfs.rst
View file

@ -64,6 +64,18 @@ packages. Additionally, keep in mind that :ref:`SSH authentication in pygit2
libraries to be present before libgit2 is built. On some distros (debian based)
``pkg-config`` is also required to link libgit2 with libssh2.
.. warning::
pygit2_ is actively developed and :ref:`frequently makes
non-backwards-compatible API changes <pygit2-version-policy>`, even in
minor releases. It is not uncommon for pygit2_ upgrades to result in errors
in Salt. Please take care when upgrading pygit2_, and pay close attention
to the :ref:`changelog <pygit2-changelog>`, keeping an eye out for API
changes. Errors can be reported on the :ref:`SaltStack issue tracker
<saltstack-issue-tracker>`.
.. _pygit2-version-policy: http://www.pygit2.org/install.html#version-numbers
.. _pygit2-changelog: https://github.com/libgit2/pygit2#changelog
.. _saltstack-issue-tracker: https://github.com/saltstack/salt/issues
.. __: http://www.pygit2.org/install.html
.. _libssh2: http://www.libssh2.org/