Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Fix allTargets config docs #16988

Merged
merged 1 commit into from
Apr 1, 2024
Merged

fix: Fix allTargets config docs #16988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions crates/rust-analyzer/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,7 @@ config_data! {
/// How many worker threads to handle priming caches. The default `0` means to pick automatically.
cachePriming_numThreads: ParallelCachePrimingNumThreads = "0",

/// Pass `--all-targets` to cargo invocation. Overridden by `#rust-analyzer.check.allTargets#`
/// when the latter is set.
/// Pass `--all-targets` to cargo invocation.
cargo_allTargets: bool = "true",
/// Automatically refresh project info via `cargo metadata` on
/// `Cargo.toml` or `.cargo/config.toml` changes.
Expand Down Expand Up @@ -166,7 +165,8 @@ config_data! {
/// Run the check command for diagnostics on save.
checkOnSave | checkOnSave_enable: bool = "true",

/// Check all targets and tests (`--all-targets`). Overrides `#rust-analyzer.cargo.allTargets#`.
/// Check all targets and tests (`--all-targets`). Defaults to
/// `#rust-analyzer.cargo.allTargets#`.
check_allTargets | checkOnSave_allTargets: Option<bool> = "null",
/// Cargo command to use for `cargo check`.
check_command | checkOnSave_command: String = "\"check\"",
Expand Down
6 changes: 3 additions & 3 deletions docs/user/generated_config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ How many worker threads to handle priming caches. The default `0` means to pick
[[rust-analyzer.cargo.allTargets]]rust-analyzer.cargo.allTargets (default: `true`)::
+
--
Pass `--all-targets` to cargo invocation. Overridden by `#rust-analyzer.check.allTargets#`
when the latter is set.
Pass `--all-targets` to cargo invocation.
--
[[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`)::
+
Expand Down Expand Up @@ -173,7 +172,8 @@ Run the check command for diagnostics on save.
[[rust-analyzer.check.allTargets]]rust-analyzer.check.allTargets (default: `null`)::
+
--
Check all targets and tests (`--all-targets`). Overrides `#rust-analyzer.cargo.allTargets#`.
Check all targets and tests (`--all-targets`). Defaults to
`#rust-analyzer.cargo.allTargets#`.
--
[[rust-analyzer.check.command]]rust-analyzer.check.command (default: `"check"`)::
+
Expand Down
4 changes: 2 additions & 2 deletions editors/code/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@
"maximum": 255
},
"rust-analyzer.cargo.allTargets": {
"markdownDescription": "Pass `--all-targets` to cargo invocation. Overridden by `#rust-analyzer.check.allTargets#`\nwhen the latter is set.",
"markdownDescription": "Pass `--all-targets` to cargo invocation.",
"default": true,
"type": "boolean"
},
Expand Down Expand Up @@ -712,7 +712,7 @@
"type": "boolean"
},
"rust-analyzer.check.allTargets": {
"markdownDescription": "Check all targets and tests (`--all-targets`). Overrides `#rust-analyzer.cargo.allTargets#`.",
"markdownDescription": "Check all targets and tests (`--all-targets`). Defaults to\n`#rust-analyzer.cargo.allTargets#`.",
"default": null,
"type": [
"null",
Expand Down