Skip to content

Commit 2d37049

Browse files
committed
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.
1 parent 80cc71e commit 2d37049

File tree

4 files changed

+12
-27
lines changed

4 files changed

+12
-27
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ codebase for `__del__` implementations and call these yourself when you see fit.
5454
Another way assure proper cleanup of resources is to factor out GitPython into a
5555
separate process which can be dropped periodically.
5656

57+
#### Best-effort for Python 2.6 and Windows support
58+
59+
This means that support for these platforms is likely to worsen over time
60+
as they are kept alive solely by their users, or not.
61+
5762
### RUNNING TESTS
5863

5964
*Important*: Right after cloning this repository, please be sure to have executed the `init-tests-after-clone.sh` script in the repository root. Otherwise you will encounter test failures.

doc/source/index.rst

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ GitPython Documentation
99
:maxdepth: 2
1010

1111
intro
12-
whatsnew
1312
tutorial
1413
reference
1514
roadmap

doc/source/intro.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Requirements
1515

1616
* `Python`_ 2.7 or newer
1717
Since GitPython 2.0.0. Please note that python 2.6 is still reasonably well supported, but might
18-
deteriorate over time.
18+
deteriorate over time. Support is provided on a best-effort basis only.
1919
* `Git`_ 1.7.0 or newer
2020
It should also work with older versions, but it may be that some operations
2121
involving remotes will not work as expected.
@@ -75,6 +75,12 @@ codebase for `__del__` implementations and call these yourself when you see fit.
7575
Another way assure proper cleanup of resources is to factor out GitPython into a
7676
separate process which can be dropped periodically.
7777

78+
Best-effort for Python 2.6 and Windows support
79+
----------------------------------------------
80+
81+
This means that support for these platforms is likely to worsen over time
82+
as they are kept alive solely by their users, or not.
83+
7884
Getting Started
7985
===============
8086

doc/source/whatsnew.rst

-25
This file was deleted.

0 commit comments

Comments
 (0)