diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2016-09-11 20:42:33 +0200 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2016-09-11 20:44:35 +0200 |
| commit | 48c149c16a9bb06591c2eb0be4cca729b7feac3e (patch) | |
| tree | 2b534be329c22de1045a95f6a979ce0cda9a73a4 | |
| parent | 06c9c919707ba4116442ca53ac7cf035540981f2 (diff) | |
| download | gitpython-48c149c16a9bb06591c2eb0be4cca729b7feac3e.tar.gz | |
doc(limitations): be very clear about known issues
Fixes #508
| -rw-r--r-- | README.md | 23 | ||||
| -rw-r--r-- | doc/source/intro.rst | 16 | ||||
| m--------- | git/ext/gitdb | 0 |
3 files changed, 30 insertions, 9 deletions
@@ -40,6 +40,20 @@ git submodule update --init --recursive ./init-tests-after-clone.sh ``` +### Limitations + +#### Leakage of System Resources + +GitPython is not suited for long-running processes (like daemons) as it tends to +leak system resources. It was written in a time where destructors (as implemented +in the `__del__` method) still ran deterministically. + +In case you still want to use it in such a context, you will want to search the +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. + ### RUNNING TESTS *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. @@ -59,13 +73,6 @@ For more fine-grained control, you can use `nose`. Please have a look at the [contributions file][contributing]. -### Live Coding - -You can watch me fix issues or implement new features [live on Twitch][twitch-channel], or have a look at [past recordings on youtube][youtube-playlist] - -* [Live on Twitch][twitch-channel] (just follow the channel to be notified when a session starts) -* [Archive on Youtube][youtube-playlist] - ### INFRASTRUCTURE * [User Documentation](http://gitpython.readthedocs.org) @@ -104,6 +111,4 @@ Now that there seems to be a massive user base, this should be motivation enough * no open pull requests * no open issues describing bugs -[twitch-channel]: http://www.twitch.tv/byronimo/profile -[youtube-playlist]: https://www.youtube.com/playlist?list=PLMHbQxe1e9MnoEcLhn6Yhv5KAvpWkJbL0 [contributing]: https://github.com/gitpython-developers/GitPython/blob/master/README.md diff --git a/doc/source/intro.rst b/doc/source/intro.rst index 6c4e50f5..1c1b0d1b 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -59,6 +59,22 @@ script: .. note:: In this case, you have to manually install `GitDB`_ as well. It would be recommended to use the :ref:`git source repository <source-code-label>` in that case. +Limitations +=========== + +Leakage of System Resources +--------------------------- + +GitPython is not suited for long-running processes (like daemons) as it tends to +leak system resources. It was written in a time where destructors (as implemented +in the `__del__` method) still ran deterministically. + +In case you still want to use it in such a context, you will want to search the +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. + Getting Started =============== diff --git a/git/ext/gitdb b/git/ext/gitdb -Subproject 2389b75280efb1a63e6ea578eae7f897fd4beb1 +Subproject 97035c64f429c229629c25becc54ae44dd95e49 |