diff options
| author | bors <bors@rust-lang.org> | 2023-09-22 16:09:01 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2023-09-22 16:09:01 +0000 |
| commit | 2b580a1f3c7bf7f2dd6d1462282362b80a6a3d91 (patch) | |
| tree | 29c53e6b6efb691a1a44948eb01fa52a39b56ea0 /docs | |
| parent | 8139e8e0723883e25164a7893ca46976cd328991 (diff) | |
| parent | ba7f2bfb85dffb0d300fedf8f9adcebb6666c8a0 (diff) | |
| download | rust-2b580a1f3c7bf7f2dd6d1462282362b80a6a3d91.tar.gz rust-2b580a1f3c7bf7f2dd6d1462282362b80a6a3d91.zip | |
Auto merge of #15492 - RalfJung:invocation, r=Veykril
extend check.overrideCommand and buildScripts.overrideCommand docs Extend check.overrideCommand and buildScripts.overrideCommand docs regarding invocation strategy and location. However something still seems a bit odd -- the docs for `invocationStrategy`/`invocationLocation` talk about "workspaces", but the setting that controls which workspaces are considered is called `linkedProjects`. Is a project the same as a workspace here or is there some subtle difference?
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/user/generated_config.adoc | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 71feed0f72c..bde1c03bef7 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc @@ -57,6 +57,12 @@ build procedural macros. The command is required to output json and should therefore include `--message-format=json` or a similar option. +If there are multiple linked projects/workspaces, this command is invoked for +each of them, with the working directory being the workspace root +(i.e., the folder containing the `Cargo.toml`). This can be overwritten +by changing `#rust-analyzer.cargo.buildScripts.invocationStrategy#` and +`#rust-analyzer.cargo.buildScripts.invocationLocation#`. + By default, a cargo invocation will be constructed for the configured targets and features, with the following base command line: @@ -206,9 +212,11 @@ If you're changing this because you're using some tool wrapping Cargo, you might also want to change `#rust-analyzer.cargo.buildScripts.overrideCommand#`. -If there are multiple linked projects, this command is invoked for -each of them, with the working directory being the project root -(i.e., the folder containing the `Cargo.toml`). +If there are multiple linked projects/workspaces, this command is invoked for +each of them, with the working directory being the workspace root +(i.e., the folder containing the `Cargo.toml`). This can be overwritten +by changing `#rust-analyzer.cargo.check.invocationStrategy#` and +`#rust-analyzer.cargo.check.invocationLocation#`. An example command would be: |