Skip to content

Commit

Permalink
Doc: Workaround for Running cargo test locally without signficant mem…
Browse files Browse the repository at this point in the history
…ory (#9402)

* document cargo test workaround

* Update docs/source/contributor-guide/index.md

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
  • Loading branch information
devinjdangelo and alamb authored Feb 29, 2024
1 parent e1ed13d commit a8a3c5d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/contributor-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ DataFusion is written in Rust and it uses a standard rust toolkit:
- `cargo test` to test
- etc.

Note that running `cargo test` requires significant memory resources, due to cargo running many tests in parallel by default. If you run into issues with slow tests or system lock ups, you can significantly reduce the memory required by instead running `cargo test -- --test-threads=1`. For more information see [this issue](https://github.com/apache/arrow-datafusion/issues/5347).

Testing setup:

- `rustup update stable` DataFusion uses the latest stable release of rust
Expand Down

0 comments on commit a8a3c5d

Please sign in to comment.