Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2025-01-13 13:48:50 +00:00
Code Issues Projects Releases Packages Wiki Activity

Auto merge of #16062 - davidbarsky:david/fix-references-to-removed-settings, r=Veykril

Browse source 
fix: Correct references from `rust-analyzer.cargo.check` to `rust-analyzer.check`

When reading the manual, I noticed that the documentation referenced configurations that have since been renamed. This PR updates those references to their new names.
This commit is contained in:
bors 2024-01-02 09:57:48 +00:00
commit 9f46ff501d
3 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
crates/rust-analyzer/src/config.rs
View file

@ -167,15 +167,15 @@ config_data! {
/// Specifies the working directory for running checks. /// Specifies the working directory for running checks.
/// - "workspace": run checks for workspaces in the corresponding workspaces' root directories. /// - "workspace": run checks for workspaces in the corresponding workspaces' root directories.
// FIXME: Ideally we would support this in some way // FIXME: Ideally we would support this in some way
/// This falls back to "root" if `#rust-analyzer.cargo.check.invocationStrategy#` is set to `once`. /// This falls back to "root" if `#rust-analyzer.check.invocationStrategy#` is set to `once`.
/// - "root": run checks in the project's root directory. /// - "root": run checks in the project's root directory.
/// This config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#` /// This config only has an effect when `#rust-analyzer.check.overrideCommand#`
/// is set. /// is set.
check_invocationLocation | checkOnSave_invocationLocation: InvocationLocation = "\"workspace\"", check_invocationLocation | checkOnSave_invocationLocation: InvocationLocation = "\"workspace\"",
/// Specifies the invocation strategy to use when running the check command. /// Specifies the invocation strategy to use when running the check command.
/// If `per_workspace` is set, the command will be executed for each workspace. /// If `per_workspace` is set, the command will be executed for each workspace.
/// If `once` is set, the command will be executed once. /// If `once` is set, the command will be executed once.
/// This config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#` /// This config only has an effect when `#rust-analyzer.check.overrideCommand#`
/// is set. /// is set.
check_invocationStrategy | checkOnSave_invocationStrategy: InvocationStrategy = "\"per_workspace\"", check_invocationStrategy | checkOnSave_invocationStrategy: InvocationStrategy = "\"per_workspace\"",
/// Whether to pass `--no-default-features` to Cargo. Defaults to /// Whether to pass `--no-default-features` to Cargo. Defaults to
@ -194,8 +194,8 @@ config_data! {
/// If there are multiple linked projects/workspaces, 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 workspace root /// each of them, with the working directory being the workspace root
/// (i.e., the folder containing the `Cargo.toml`). This can be overwritten /// (i.e., the folder containing the `Cargo.toml`). This can be overwritten
/// by changing `#rust-analyzer.cargo.check.invocationStrategy#` and /// by changing `#rust-analyzer.check.invocationStrategy#` and
/// `#rust-analyzer.cargo.check.invocationLocation#`. /// `#rust-analyzer.check.invocationLocation#`.
/// ///
/// An example command would be: /// An example command would be:
/// ///

10
docs/user/generated_config.adoc
View file

@ -185,9 +185,9 @@ For example for `cargo check`: `dead_code`, `unused_imports`, `unused_variables`
-- --
Specifies the working directory for running checks. Specifies the working directory for running checks.
- "workspace": run checks for workspaces in the corresponding workspaces' root directories. - "workspace": run checks for workspaces in the corresponding workspaces' root directories.
This falls back to "root" if `#rust-analyzer.cargo.check.invocationStrategy#` is set to `once`. This falls back to "root" if `#rust-analyzer.check.invocationStrategy#` is set to `once`.
- "root": run checks in the project's root directory. - "root": run checks in the project's root directory.
This config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#` This config only has an effect when `#rust-analyzer.check.overrideCommand#`
is set. is set.
-- --
[[rust-analyzer.check.invocationStrategy]]rust-analyzer.check.invocationStrategy (default: `"per_workspace"`):: [[rust-analyzer.check.invocationStrategy]]rust-analyzer.check.invocationStrategy (default: `"per_workspace"`)::
@ -196,7 +196,7 @@ is set.
Specifies the invocation strategy to use when running the check command. Specifies the invocation strategy to use when running the check command.
If `per_workspace` is set, the command will be executed for each workspace. If `per_workspace` is set, the command will be executed for each workspace.
If `once` is set, the command will be executed once. If `once` is set, the command will be executed once.
This config only has an effect when `#rust-analyzer.cargo.check.overrideCommand#` This config only has an effect when `#rust-analyzer.check.overrideCommand#`
is set. is set.
-- --
[[rust-analyzer.check.noDefaultFeatures]]rust-analyzer.check.noDefaultFeatures (default: `null`):: [[rust-analyzer.check.noDefaultFeatures]]rust-analyzer.check.noDefaultFeatures (default: `null`)::
@ -221,8 +221,8 @@ Cargo, you might also want to change
If there are multiple linked projects/workspaces, 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 workspace root each of them, with the working directory being the workspace root
(i.e., the folder containing the `Cargo.toml`). This can be overwritten (i.e., the folder containing the `Cargo.toml`). This can be overwritten
by changing `#rust-analyzer.cargo.check.invocationStrategy#` and by changing `#rust-analyzer.check.invocationStrategy#` and
`#rust-analyzer.cargo.check.invocationLocation#`. `#rust-analyzer.check.invocationLocation#`.
An example command would be: An example command would be:

6
editors/code/package.json
View file

@ -736,7 +736,7 @@
"uniqueItems": true "uniqueItems": true
}, },
"rust-analyzer.check.invocationLocation": { "rust-analyzer.check.invocationLocation": {
"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.", "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.",
"default": "workspace", "default": "workspace",
"type": "string", "type": "string",
"enum": [ "enum": [
@ -749,7 +749,7 @@
] ]
}, },
"rust-analyzer.check.invocationStrategy": { "rust-analyzer.check.invocationStrategy": {
"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.", "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.",
"default": "per_workspace", "default": "per_workspace",
"type": "string", "type": "string",
"enum": [ "enum": [
@ -770,7 +770,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/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.", "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.",
"default": null, "default": null,
"type": [ "type": [
"null", "null",