Update config docs
This commit is contained in:
parent
2de62be09b
commit
ba7f2bfb85
@ -57,6 +57,12 @@ build procedural macros. The command is required to output json
|
|||||||
and should therefore include `--message-format=json` or a similar
|
and should therefore include `--message-format=json` or a similar
|
||||||
option.
|
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
|
By default, a cargo invocation will be constructed for the configured
|
||||||
targets and features, with the following base command line:
|
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
|
Cargo, you might also want to change
|
||||||
`#rust-analyzer.cargo.buildScripts.overrideCommand#`.
|
`#rust-analyzer.cargo.buildScripts.overrideCommand#`.
|
||||||
|
|
||||||
If there are multiple linked projects, this command is invoked for
|
If there are multiple linked projects/workspaces, this command is invoked for
|
||||||
each of them, with the working directory being the project root
|
each of them, with the working directory being the workspace root
|
||||||
(i.e., the folder containing the `Cargo.toml`).
|
(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:
|
An example command would be:
|
||||||
|
|
||||||
|
@ -560,7 +560,7 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"rust-analyzer.cargo.buildScripts.overrideCommand": {
|
"rust-analyzer.cargo.buildScripts.overrideCommand": {
|
||||||
"markdownDescription": "Override the command rust-analyzer uses to run build scripts and\nbuild procedural macros. The command is required to output json\nand should therefore include `--message-format=json` or a similar\noption.\n\nBy default, a cargo invocation will be constructed for the configured\ntargets and features, with the following base command line:\n\n```bash\ncargo check --quiet --workspace --message-format=json --all-targets\n```\n.",
|
"markdownDescription": "Override the command rust-analyzer uses to run build scripts and\nbuild procedural macros. The command is required to output json\nand should therefore include `--message-format=json` or a similar\noption.\n\nIf there are multiple linked projects/workspaces, this command is invoked for\neach of them, with the working directory being the workspace root\n(i.e., the folder containing the `Cargo.toml`). This can be overwritten\nby changing `#rust-analyzer.cargo.buildScripts.invocationStrategy#` and\n`#rust-analyzer.cargo.buildScripts.invocationLocation#`.\n\nBy default, a cargo invocation will be constructed for the configured\ntargets and features, with the following base command line:\n\n```bash\ncargo check --quiet --workspace --message-format=json --all-targets\n```\n.",
|
||||||
"default": null,
|
"default": null,
|
||||||
"type": [
|
"type": [
|
||||||
"null",
|
"null",
|
||||||
@ -749,7 +749,7 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"rust-analyzer.check.overrideCommand": {
|
"rust-analyzer.check.overrideCommand": {
|
||||||
"markdownDescription": "Override the command rust-analyzer uses instead of `cargo check` for\ndiagnostics on save. The command is required to output json and\nshould therefore include `--message-format=json` or a similar option\n(if your client supports the `colorDiagnosticOutput` experimental\ncapability, you can use `--message-format=json-diagnostic-rendered-ansi`).\n\nIf you're changing this because you're using some tool wrapping\nCargo, you might also want to change\n`#rust-analyzer.cargo.buildScripts.overrideCommand#`.\n\nIf there are multiple linked projects, this command is invoked for\neach of them, with the working directory being the project root\n(i.e., the folder containing the `Cargo.toml`).\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n.",
|
"markdownDescription": "Override the command rust-analyzer uses instead of `cargo check` for\ndiagnostics on save. The command is required to output json and\nshould therefore include `--message-format=json` or a similar option\n(if your client supports the `colorDiagnosticOutput` experimental\ncapability, you can use `--message-format=json-diagnostic-rendered-ansi`).\n\nIf you're changing this because you're using some tool wrapping\nCargo, you might also want to change\n`#rust-analyzer.cargo.buildScripts.overrideCommand#`.\n\nIf there are multiple linked projects/workspaces, this command is invoked for\neach of them, with the working directory being the workspace root\n(i.e., the folder containing the `Cargo.toml`). This can be overwritten\nby changing `#rust-analyzer.cargo.check.invocationStrategy#` and\n`#rust-analyzer.cargo.check.invocationLocation#`.\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n.",
|
||||||
"default": null,
|
"default": null,
|
||||||
"type": [
|
"type": [
|
||||||
"null",
|
"null",
|
||||||
|
Loading…
Reference in New Issue
Block a user