diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2015-08-22 16:39:34 +0200 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2015-08-22 16:40:10 +0200 |
| commit | 17413029b0f780ac94c24ab2b5f527ded6abdd2a (patch) | |
| tree | 853c1cd0246e2c52d76afcc72669aeed4cf2822d | |
| parent | b4cde7d2cace3a2d90f6df9498e532668ad17966 (diff) | |
| download | gitdb-17413029b0f780ac94c24ab2b5f527ded6abdd2a.tar.gz | |
docs(gitdb): discourage usage of GitDB type
| -rw-r--r-- | gitdb/db/git.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/gitdb/db/git.py b/gitdb/db/git.py index a4f6f54..7a43d72 100644 --- a/gitdb/db/git.py +++ b/gitdb/db/git.py @@ -22,7 +22,11 @@ __all__ = ('GitDB', ) class GitDB(FileDBBase, ObjectDBW, CompoundDB): """A git-style object database, which contains all objects in the 'objects' - subdirectory""" + subdirectory + + ``IMPORTANT``: The usage of this implementation is highly discouraged as it fails to release file-handles. + This can be a problem with long-running processes and/or big repositories. + """ # Configuration PackDBCls = PackedDB LooseDBCls = LooseObjectDB |