Skip to content

Commit 1741302

Browse files
committed
docs(gitdb): discourage usage of GitDB type
1 parent b4cde7d commit 1741302

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

gitdb/db/git.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@
2222
class GitDB(FileDBBase, ObjectDBW, CompoundDB):
2323

2424
"""A git-style object database, which contains all objects in the 'objects'
25-
subdirectory"""
25+
subdirectory
26+
27+
``IMPORTANT``: The usage of this implementation is highly discouraged as it fails to release file-handles.
28+
This can be a problem with long-running processes and/or big repositories.
29+
"""
2630
# Configuration
2731
PackDBCls = PackedDB
2832
LooseDBCls = LooseObjectDB

0 commit comments

Comments
 (0)