summaryrefslogtreecommitdiff
path: root/doc/source/intro.rst
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2016-09-25 15:17:54 +0200
committerSebastian Thiel <byronimo@gmail.com>2016-09-25 15:17:54 +0200
commit2d37049a815b11b594776d34be50e9c0ba8df497 (patch)
tree4f99e902755a306c7597cd6246becc055974dd70 /doc/source/intro.rst
parent80cc71edc172b395db8f14beb7add9a61c4cc2b6 (diff)
downloadgitpython-2d37049a815b11b594776d34be50e9c0ba8df497.tar.gz
doc(platforms): inform more clearly about best-effort
This has been the case for Windows as well, and is now made official. Certain tests already fail on windows, for example.
Diffstat (limited to 'doc/source/intro.rst')
-rw-r--r--doc/source/intro.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/source/intro.rst b/doc/source/intro.rst
index 1c1b0d1b..1766f8ae 100644
--- a/doc/source/intro.rst
+++ b/doc/source/intro.rst
@@ -15,7 +15,7 @@ Requirements
* `Python`_ 2.7 or newer
Since GitPython 2.0.0. Please note that python 2.6 is still reasonably well supported, but might
- deteriorate over time.
+ deteriorate over time. Support is provided on a best-effort basis only.
* `Git`_ 1.7.0 or newer
It should also work with older versions, but it may be that some operations
involving remotes will not work as expected.
@@ -75,6 +75,12 @@ codebase for `__del__` implementations and call these yourself when you see fit.
Another way assure proper cleanup of resources is to factor out GitPython into a
separate process which can be dropped periodically.
+Best-effort for Python 2.6 and Windows support
+----------------------------------------------
+
+This means that support for these platforms is likely to worsen over time
+as they are kept alive solely by their users, or not.
+
Getting Started
===============