diff options
Diffstat (limited to 'docs/user')
| -rw-r--r-- | docs/user/generated_config.adoc | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 981132f9c4d..b0f2f1614db 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc @@ -29,7 +29,7 @@ Run build scripts (`build.rs`) for more precise code analysis. -- Override the command rust-analyzer uses to run build scripts and build procedural macros. The command is required to output json -and should therefor include `--message-format=json` or a similar +and should therefore include `--message-format=json` or a similar option. By default, a cargo invocation will be constructed for the configured @@ -44,7 +44,7 @@ cargo check --quiet --workspace --message-format=json --all-targets + -- Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to -avoid compiling unnecessary things. +avoid checking unnecessary things. -- [[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`):: + @@ -99,21 +99,24 @@ Extra arguments for `cargo check`. List of features to activate. Defaults to `#rust-analyzer.cargo.features#`. -Set to `"all"` to pass `--all-features` to cargo. +Set to `"all"` to pass `--all-features` to Cargo. -- [[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`):: + -- -Whether to pass `--no-default-features` to cargo. Defaults to +Whether to pass `--no-default-features` to Cargo. Defaults to `#rust-analyzer.cargo.noDefaultFeatures#`. -- [[rust-analyzer.checkOnSave.overrideCommand]]rust-analyzer.checkOnSave.overrideCommand (default: `null`):: + -- -Override the command rust-analyzer uses to run build scripts and -build procedural macros. The command is required to output json -and should therefor include `--message-format=json` or a similar -option. +Override the command rust-analyzer uses instead of `cargo check` for +diagnostics on save. The command is required to output json and +should therefor include `--message-format=json` or a similar option. + +If you're changing this because you're using some tool wrapping +Cargo, you might also want to change +`#rust-analyzer.cargo.buildScripts.overrideCommand#`. An example command would be: |