Skip to content

Commit e43e124

Browse files
committed
Document rustc source auto-discovery
1 parent 5e8f4dc commit e43e124

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

crates/rust-analyzer/src/config.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,12 +263,13 @@ config_data! {
263263
runnables_cargoExtraArgs: Vec<String> = "[]",
264264

265265
/// Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private
266-
/// projects, or "discover" to try to automatically find it.
266+
/// projects, or "discover" to try to automatically find it if the `rustc-dev` component
267+
/// is installed.
267268
///
268269
/// Any project which uses rust-analyzer with the rustcPrivate
269270
/// crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.
270271
///
271-
/// This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
272+
/// This option does not take effect until rust-analyzer is restarted.
272273
rustcSource: Option<String> = "null",
273274

274275
/// Additional arguments to `rustfmt`.

docs/user/generated_config.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -420,12 +420,13 @@ tests or binaries. For example, it may be `--release`.
420420
+
421421
--
422422
Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private
423-
projects, or "discover" to try to automatically find it.
423+
projects, or "discover" to try to automatically find it if the `rustc-dev` component
424+
is installed.
424425

425426
Any project which uses rust-analyzer with the rustcPrivate
426427
crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.
427428

428-
This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
429+
This option does not take effect until rust-analyzer is restarted.
429430
--
430431
[[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`)::
431432
+

editors/code/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -867,7 +867,7 @@
867867
}
868868
},
869869
"rust-analyzer.rustcSource": {
870-
"markdownDescription": "Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private\nprojects, or \"discover\" to try to automatically find it.\n\nAny project which uses rust-analyzer with the rustcPrivate\ncrates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.\n\nThis option is not reloaded automatically; you must restart rust-analyzer for it to take effect.",
870+
"markdownDescription": "Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private\nprojects, or \"discover\" to try to automatically find it if the `rustc-dev` component\nis installed.\n\nAny project which uses rust-analyzer with the rustcPrivate\ncrates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.\n\nThis option does not take effect until rust-analyzer is restarted.",
871871
"default": null,
872872
"type": [
873873
"null",

0 commit comments

Comments
 (0)