rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Improve documentation for buildScripts.overrideCommand / checkOnSave.overrideCommand

Browse Source
This commit is contained in:
Florian Diebold
2022-07-04 18:45:54 +02:00
parent 75b22326da
commit ccf854bc2e
3 changed files with 27 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
crates/rust-analyzer/src/config.rs
View File

@@ -69,7 +69,7 @@ config_data! {
cargo_buildScripts_enable: bool = "true",
/// 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
@@ -81,7 +81,7 @@ config_data! {
/// .
cargo_buildScripts_overrideCommand: Option<Vec<String>> = "null",
/// Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to
/// avoid compiling unnecessary things.
/// avoid checking unnecessary things.
cargo_buildScripts_useRustcWrapper: bool = "true",
/// List of features to activate.
///
@@ -107,15 +107,18 @@ config_data! {
/// 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.
checkOnSave_features: Option<CargoFeatures> = "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#`.
checkOnSave_noDefaultFeatures: Option<bool> = "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:
///