Skip to content

Commit 1e3152e

Browse files
authored
Update dev env documentation to reflect pinned rust version (#17107)
* Add rust-analyzer component to rust-toolchain.toml * Update dev env documentation about pinned rust version
1 parent e58f86c commit 1e3152e

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/source/contributor-guide/development_environment.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,20 @@ Alternatively a binary release can be downloaded from the [Release Page](https:/
7575

7676
DataFusion is written in Rust and it uses a standard rust toolkit:
7777

78+
- `rustup update stable` DataFusion generally uses the latest stable release of Rust, though it may lag when new Rust toolchains release
79+
- See which toolchain is currently pinned in the [`rust-toolchain.toml`](https://github.com/apache/datafusion/blob/main/rust-toolchain.toml) file
80+
- This can cause issues such as not having the rust-analyzer component installed for the specified toolchain, in which case just install it manually, e.g. `rustup component add --toolchain 1.88 rust-analyzer`
7881
- `cargo build`
7982
- `cargo fmt` to format the code
80-
- `cargo test` to test
8183
- etc.
8284

83-
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/datafusion/issues/5347).
84-
8585
Testing setup:
8686

87-
- `rustup update stable` DataFusion uses the latest stable release of rust
8887
- `git submodule init`
8988
- `git submodule update --init --remote --recursive`
89+
- `cargo test` to run tests
90+
91+
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/datafusion/issues/5347).
9092

9193
Formatting instructions:
9294

0 commit comments

Comments
 (0)