Skip to content

docs: warn about GitDB performance with large commits #2115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Byron merged 1 commit into from
Mar 22, 2026
Merged

docs: warn about GitDB performance with large commits #2115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/source/tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,12 @@ The GitDB is a pure-python implementation of the git object database. It is the

repo = Repo("path/to/repo", odbt=GitDB)

.. warning::
``GitDB`` may fail or become extremely slow when traversing trees in
repositories with very large commits (thousands of changed files in a
single commit). If you encounter ``RecursionError`` or excessive
slowness during tree traversal, switch to ``GitCmdObjectDB`` instead.


GitCmdObjectDB
==============
Expand Down
Loading