Commit2d37049

committed

doc(platforms): inform more clearly about best-effort

This has been the case for Windows as well, and is nowmade official.Certain tests already fail on windows, for example.

1 parent80cc71e commit2d37049Copy full SHA for 2d37049

File tree

+12

-27

lines changed

+12

-27

lines changed

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -54,6 +54,11 @@ codebase for `__del__` implementations and call these yourself when you see fit.
`54`	`54`	`Another way assure proper cleanup of resources is to factor out GitPython into a`
`55`	`55`	`separate process which can be dropped periodically.`
`56`	`56`
	`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`	`+`
`57`	`62`	`###RUNNING TESTS`
`58`	`63`
`59`	`64`	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.

Lines changed: 0 additions & 1 deletion

Lines changed: 7 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ Requirements`
`15`	`15`
`16`	`16`	* `Python`_ 2.7 or newer
`17`	`17`	`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.`
`19`	`19`	* `Git`_ 1.7.0 or newer
`20`	`20`	`It should also work with older versions, but it may be that some operations`
`21`	`21`	`involving remotes will not work as expected.`
@@ -75,6 +75,12 @@ codebase for `__del__` implementations and call these yourself when you see fit.
`75`	`75`	`Another way assure proper cleanup of resources is to factor out GitPython into a`
`76`	`76`	`separate process which can be dropped periodically.`
`77`	`77`
	`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`	`+`
`78`	`84`	`Getting Started`
`79`	`85`	`===============`
`80`	`86`

Lines changed: 0 additions & 25 deletions

This file was deleted.

Comments

(0)