Skip to content

Commit f556c79

Browse files
committed
fix: Correct references from rust-analyzer.cargo.check to rust-analyzer.check
1 parent 0395328 commit f556c79

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

crates/rust-analyzer/src/config.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -164,15 +164,15 @@ config_data! {
164164
/// Specifies the working directory for running checks.
165165
/// - "workspace": run checks for workspaces in the corresponding workspaces' root directories.
166166
// FIXME: Ideally we would support this in some way
167-
/// This falls back to "root" if `#rust-analyzer.cargo.check.invocationStrategy#` is set to `once`.
167+
/// This falls back to "root" if `#rust-analyzer.check.invocationStrategy#` is set to `once`.
168168
/// - "root": run checks in the project's root directory.
169-
/// This config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#`
169+
/// This config only has an effect when `#rust-analyzer.check.overrideCommand#`
170170
/// is set.
171171
check_invocationLocation | checkOnSave_invocationLocation: InvocationLocation = "\"workspace\"",
172172
/// Specifies the invocation strategy to use when running the check command.
173173
/// If `per_workspace` is set, the command will be executed for each workspace.
174174
/// If `once` is set, the command will be executed once.
175-
/// This config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#`
175+
/// This config only has an effect when `#rust-analyzer.check.overrideCommand#`
176176
/// is set.
177177
check_invocationStrategy | checkOnSave_invocationStrategy: InvocationStrategy = "\"per_workspace\"",
178178
/// Whether to pass `--no-default-features` to Cargo. Defaults to
@@ -191,8 +191,8 @@ config_data! {
191191
/// If there are multiple linked projects/workspaces, this command is invoked for
192192
/// each of them, with the working directory being the workspace root
193193
/// (i.e., the folder containing the `Cargo.toml`). This can be overwritten
194-
/// by changing `#rust-analyzer.cargo.check.invocationStrategy#` and
195-
/// `#rust-analyzer.cargo.check.invocationLocation#`.
194+
/// by changing `#rust-analyzer.check.invocationStrategy#` and
195+
/// `#rust-analyzer.check.invocationLocation#`.
196196
///
197197
/// An example command would be:
198198
///

docs/user/generated_config.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -179,9 +179,9 @@ For example for `cargo check`: `dead_code`, `unused_imports`, `unused_variables`
179179
--
180180
Specifies the working directory for running checks.
181181
- "workspace": run checks for workspaces in the corresponding workspaces' root directories.
182-
This falls back to "root" if `#rust-analyzer.cargo.check.invocationStrategy#` is set to `once`.
182+
This falls back to "root" if `#rust-analyzer.check.invocationStrategy#` is set to `once`.
183183
- "root": run checks in the project's root directory.
184-
This config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#`
184+
This config only has an effect when `#rust-analyzer.check.overrideCommand#`
185185
is set.
186186
--
187187
[[rust-analyzer.check.invocationStrategy]]rust-analyzer.check.invocationStrategy (default: `"per_workspace"`)::
@@ -190,7 +190,7 @@ is set.
190190
Specifies the invocation strategy to use when running the check command.
191191
If `per_workspace` is set, the command will be executed for each workspace.
192192
If `once` is set, the command will be executed once.
193-
This config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#`
193+
This config only has an effect when `#rust-analyzer.check.overrideCommand#`
194194
is set.
195195
--
196196
[[rust-analyzer.check.noDefaultFeatures]]rust-analyzer.check.noDefaultFeatures (default: `null`)::
@@ -215,8 +215,8 @@ Cargo, you might also want to change
215215
If there are multiple linked projects/workspaces, this command is invoked for
216216
each of them, with the working directory being the workspace root
217217
(i.e., the folder containing the `Cargo.toml`). This can be overwritten
218-
by changing `#rust-analyzer.cargo.check.invocationStrategy#` and
219-
`#rust-analyzer.cargo.check.invocationLocation#`.
218+
by changing `#rust-analyzer.check.invocationStrategy#` and
219+
`#rust-analyzer.check.invocationLocation#`.
220220

221221
An example command would be:
222222

editors/code/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -731,7 +731,7 @@
731731
"uniqueItems": true
732732
},
733733
"rust-analyzer.check.invocationLocation": {
734-
"markdownDescription": "Specifies the working directory for running checks.\n- \"workspace\": run checks for workspaces in the corresponding workspaces' root directories.\n This falls back to \"root\" if `#rust-analyzer.cargo.check.invocationStrategy#` is set to `once`.\n- \"root\": run checks in the project's root directory.\nThis config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#`\nis set.",
734+
"markdownDescription": "Specifies the working directory for running checks.\n- \"workspace\": run checks for workspaces in the corresponding workspaces' root directories.\n This falls back to \"root\" if `#rust-analyzer.check.invocationStrategy#` is set to `once`.\n- \"root\": run checks in the project's root directory.\nThis config only has an effect when `#rust-analyzer.check.overrideCommand#`\nis set.",
735735
"default": "workspace",
736736
"type": "string",
737737
"enum": [
@@ -744,7 +744,7 @@
744744
]
745745
},
746746
"rust-analyzer.check.invocationStrategy": {
747-
"markdownDescription": "Specifies the invocation strategy to use when running the check command.\nIf `per_workspace` is set, the command will be executed for each workspace.\nIf `once` is set, the command will be executed once.\nThis config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#`\nis set.",
747+
"markdownDescription": "Specifies the invocation strategy to use when running the check command.\nIf `per_workspace` is set, the command will be executed for each workspace.\nIf `once` is set, the command will be executed once.\nThis config only has an effect when `#rust-analyzer.check.overrideCommand#`\nis set.",
748748
"default": "per_workspace",
749749
"type": "string",
750750
"enum": [
@@ -765,7 +765,7 @@
765765
]
766766
},
767767
"rust-analyzer.check.overrideCommand": {
768-
"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.",
768+
"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.check.invocationStrategy#` and\n`#rust-analyzer.check.invocationLocation#`.\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n.",
769769
"default": null,
770770
"type": [
771771
"null",

0 commit comments

Comments
 (0)