(arrow-datafusion) branch main updated: Doc: Workaround for Running cargo test locally without signficant memory (#9402)

[co...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

comphead pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git


The following commit(s) were added to refs/heads/main by this push:
     new a8a3c5d17a Doc: Workaround for Running cargo test locally without signficant memory (#9402)
a8a3c5d17a is described below

commit a8a3c5d17ae4bf0e6d70bdd7d1bad795c57d0658
Author: Devin D'Angelo <de...@gmail.com>
AuthorDate: Thu Feb 29 17:42:19 2024 -0500

    Doc: Workaround for Running cargo test locally without signficant memory (#9402)
    
    * document cargo test workaround
    
    * Update docs/source/contributor-guide/index.md
    
    ---------
    
    Co-authored-by: Andrew Lamb <an...@nerdnetworks.org>
---
 docs/source/contributor-guide/index.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/source/contributor-guide/index.md b/docs/source/contributor-guide/index.md
index 839055f6ed..58291e5b78 100644
--- a/docs/source/contributor-guide/index.md
+++ b/docs/source/contributor-guide/index.md
@@ -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