Doc: Workaround for Running cargo test locally without signficant memory #9402
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Closes #9398
Closes #5347
Rationale for this change
New contributors (myself included!) often run
cargo testlocally when setting up DataFusion for development and are surprised to see their system lock up or fail to complete the tests. This is due to very high memory requirements to complete the tests with default parallelism. See linked issues for more discussion on the cause of high memory usage.What changes are included in this PR?
Documents this phenomenon in the contributors documentation page and suggests a workaround to run
cargo test -- --test-threads 1if you run into memory limitations.
Are these changes tested?
No - just a doc update.
Are there any user-facing changes?
New contributor docs