Skip to content

docs: warn about GitDB performance with large commits#2115

Merged
Byron merged 1 commit intogitpython-developers:mainfrom
mvanhorn:docs/gitdb-performance-warning
Mar 22, 2026
Merged

docs: warn about GitDB performance with large commits#2115
Byron merged 1 commit intogitpython-developers:mainfrom
mvanhorn:docs/gitdb-performance-warning

Conversation

@mvanhorn
Copy link
Contributor

Adds a warning in the tutorial's Object Database section (doc/source/tutorial.rst, line 515) about GitDB failing or running extremely slowly when traversing trees in repositories with very large commits. Directs users to use GitCmdObjectDB instead. Closes #2065. This contribution was developed with AI assistance (Claude Code).

Add a warning note in the Object Database section of the tutorial
about GitDB failing or becoming extremely slow when traversing trees
in repositories with very large commits (thousands of changed files).
Directs users to switch to GitCmdObjectDB instead.

Closes gitpython-developers#2065
Copy link
Member

@Byron Byron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot, much appreciated!

@Byron Byron merged commit d0318a6 into gitpython-developers:main Mar 22, 2026
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Improve Tutorial to warn about GitDB object database

2 participants