summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDan Aloni <alonid@gmail.com>2018-06-28 00:36:02 +0300
committerw0rp <w0rp@users.noreply.github.com>2018-06-27 22:36:02 +0100
commitd9e139ae2384b04af05ce9343aa0d0a5bae5449b (patch)
tree4298b157ed7eb253f55f616b7a54e2e6b72aed96 /doc
parent980aa35566f1a5c66c7b9939bb07ec68deebccb2 (diff)
downloadale-d9e139ae2384b04af05ce9343aa0d0a5bae5449b.zip
Rust Cargo linter: Improve workspace support (#1679)
* Rust Cargo linter: Improve workspace support When using Cargo workspaces [1], there is a 'Cargo.toml' directory in a top level directory, listing all the crates in the project. If we are currently editing one of the crates, 'cargo build' should execute in that directory for that crate's separate `Cargo.toml`, otherwise Cargo may spend more time possibly rebuilding the entire workspace, and maybe failing on one of the other crates, instead of succeeding on the current. [1] https://doc.rust-lang.org/book/second-edition/ch14-03-cargo-workspaces.html
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-rust.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt
index f9afe17d..d61e5b55 100644
--- a/doc/ale-rust.txt
+++ b/doc/ale-rust.txt
@@ -108,6 +108,15 @@ g:ale_rust_cargo_include_features *g:ale_rust_cargo_include_features*
When defined, ALE will set the `--features` option when invoking `cargo` to
perform the lint check. See |g:ale_rust_cargo_default_feature_behavior|.
+g:ale_rust_cargo_avoid_whole_workspace *g:ale_rust_cargo_avoid_whole_workspace*
+ *b:ale_rust_cargo_avoid_whole_workspace*
+ Type: |Number|
+ Default: `1`
+
+ When set to 1, and ALE is used to edit a crate that is part of a Cargo
+ workspace, avoid building the entire entire workspace by invoking
+ `cargo` directly in the crate's directory. Otherwise, behave as usual.
+
===============================================================================
rls *ale-rust-rls*